lemmy-js-client 1.0.0-block-nsfw.1 → 1.0.0-comment-lock.0

package/dist/types/Community.d.ts

@@ -20,8 +20,8 @@ export type Community = {
      * Whether the community is removed by a mod.
      */
     removed: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * Whether the community has been deleted by its creator.
      */
@@ -46,10 +46,6 @@ export type Community = {
      * A URL for a banner.
      */
     banner?: DbUrl;
-    /**
-     * Whether the community is hidden.
-     */
-    hidden: boolean;
     /**
      * Whether posting is restricted to mods only.
      */
@@ -60,4 +56,27 @@ export type Community = {
      * A shorter, one-line description of the site.
      */
     description?: string;
+    subscribers: number;
+    posts: number;
+    comments: number;
+    /**
+     * 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;
+    report_count: number;
+    unresolved_report_count: number;
+    local_removed: boolean;
 };

package/dist/types/CommunityActions.d.ts

@@ -0,0 +1,29 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
+export type CommunityActions = {
+    /**
+     * When the community was followed.
+     */
+    followed_at?: string;
+    /**
+     * The state of the community follow.
+     */
+    follow_state?: CommunityFollowerState;
+    /**
+     * When the community was blocked.
+     */
+    blocked_at?: string;
+    /**
+     * When this user became a moderator.
+     */
+    became_moderator_at?: string;
+    /**
+     * When this user received a ban.
+     */
+    received_ban_at?: string;
+    /**
+     * When their ban expires.
+     */
+    ban_expires_at?: string;
+    notifications?: CommunityNotificationsMode;
+};

package/dist/types/CommunityIdQuery.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityId } from "./CommunityId";
+/**
+ * Parameter for setting community icon or banner. Can't use POST data here as it already contains
+ * the image data.
+ */
+export type CommunityIdQuery = {
+    id: CommunityId;
+};

package/dist/types/CommunityNotificationsMode.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Available settings for community notifications
+ */
+export type CommunityNotificationsMode = "AllPostsAndComments" | "AllPosts" | "RepliesAndMentions" | "Mute";

package/dist/types/CommunityReport.d.ts

@@ -17,6 +17,6 @@ export type CommunityReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
 };

package/dist/types/CommunityReportResponse.d.ts

@@ -0,0 +1,7 @@
+import type { CommunityReportView } from "./CommunityReportView";
+/**
+ * A community report response.
+ */
+export type CommunityReportResponse = {
+    community_report_view: CommunityReportView;
+};

package/dist/types/CommunityReportView.d.ts

@@ -1,8 +1,6 @@
 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.
  */
@@ -10,7 +8,9 @@ export type CommunityReportView = {
     community_report: CommunityReport;
     community: Community;
     creator: Person;
-    counts: CommunityAggregates;
-    subscribed: SubscribedType;
     resolver?: Person;
+    creator_is_admin: boolean;
+    creator_is_moderator: boolean;
+    creator_banned: boolean;
+    creator_banned_from_community: boolean;
 };

package/dist/types/CommunityView.d.ts

@@ -1,14 +1,12 @@
 import type { Community } from "./Community";
-import type { CommunityAggregates } from "./CommunityAggregates";
-import type { SubscribedType } from "./SubscribedType";
+import type { CommunityActions } from "./CommunityActions";
+import type { TagsView } from "./TagsView";
 /**
  * A community view.
  */
 export type CommunityView = {
     community: Community;
-    subscribed: SubscribedType;
-    blocked: boolean;
-    counts: CommunityAggregates;
-    banned_from_community: boolean;
+    community_actions?: CommunityActions;
     can_mod: boolean;
+    post_tags: TagsView;
 };

package/dist/types/CommunityVisibility.d.ts

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

package/dist/types/CreateCommunityReport.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityId } from "./CommunityId";
+/**
+ * Create a report for a community.
+ */
+export type CreateCommunityReport = {
+    community_id: CommunityId;
+    reason: string;
+};

package/dist/types/CreateCommunityTag.d.ts

@@ -0,0 +1,10 @@
+import type { CommunityId } from "./CommunityId";
+/**
+ * Create a tag for a community.
+ */
+export type CreateCommunityTag = {
+    community_id: CommunityId;
+    name: string;
+    display_name?: string;
+    description?: string;
+};

package/dist/types/CreateMultiCommunity.d.ts

@@ -0,0 +1,5 @@
+export type CreateMultiCommunity = {
+    name: string;
+    title?: string;
+    description?: string;
+};

package/dist/types/CreateOrDeleteMultiCommunityEntry.d.ts

@@ -0,0 +1,6 @@
+import type { CommunityId } from "./CommunityId";
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type CreateOrDeleteMultiCommunityEntry = {
+    id: MultiCommunityId;
+    community_id: CommunityId;
+};

package/dist/types/CreatePost.d.ts

@@ -30,5 +30,5 @@ export type CreatePost = {
     /**
      * Time when this post should be scheduled. Null means publish immediately.
      */
-    scheduled_publish_time?: number;
+    scheduled_publish_time_at?: number;
 };

package/dist/types/CreateSite.d.ts

@@ -2,6 +2,7 @@ import type { CommentSortType } from "./CommentSortType";
 import type { FederationMode } from "./FederationMode";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
+import type { MultiCommunityId } from "./MultiCommunityId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
@@ -24,22 +25,23 @@ export type CreateSite = {
     default_comment_sort_type?: CommentSortType;
     legal_information?: string;
     application_email_admins?: boolean;
-    hide_modlog_mod_names?: boolean;
     discussion_languages?: Array<LanguageId>;
     slur_filter_regex?: string;
     actor_name_max_length?: number;
-    rate_limit_message?: number;
-    rate_limit_message_per_second?: number;
-    rate_limit_post?: number;
-    rate_limit_post_per_second?: number;
-    rate_limit_register?: number;
-    rate_limit_register_per_second?: number;
-    rate_limit_image?: number;
-    rate_limit_image_per_second?: number;
-    rate_limit_comment?: number;
-    rate_limit_comment_per_second?: number;
-    rate_limit_search?: number;
-    rate_limit_search_per_second?: number;
+    rate_limit_message_max_requests?: number;
+    rate_limit_message_interval_seconds?: number;
+    rate_limit_post_max_requests?: number;
+    rate_limit_post_interval_seconds?: number;
+    rate_limit_register_max_requests?: number;
+    rate_limit_register_interval_seconds?: number;
+    rate_limit_image_max_requests?: number;
+    rate_limit_image_interval_seconds?: number;
+    rate_limit_comment_max_requests?: number;
+    rate_limit_comment_interval_seconds?: number;
+    rate_limit_search_max_requests?: number;
+    rate_limit_search_interval_seconds?: number;
+    rate_limit_import_user_settings_max_requests?: number;
+    rate_limit_import_user_settings_interval_seconds?: number;
     federation_enabled?: boolean;
     captcha_enabled?: boolean;
     captcha_difficulty?: string;
@@ -50,5 +52,7 @@ export type CreateSite = {
     post_downvotes?: FederationMode;
     comment_upvotes?: FederationMode;
     comment_downvotes?: FederationMode;
-    disable_donation_dialog?: boolean;
+    disallow_nsfw_content?: boolean;
+    disable_email_notifications?: boolean;
+    suggested_communities?: MultiCommunityId;
 };

package/dist/types/CustomEmoji.d.ts

@@ -9,6 +9,6 @@ export type CustomEmoji = {
     image_url: DbUrl;
     alt_text: string;
     category: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
 };

package/dist/types/DeleteCommunityTag.d.ts

@@ -0,0 +1,7 @@
+import type { TagId } from "./TagId";
+/**
+ * Delete a community tag.
+ */
+export type DeleteCommunityTag = {
+    tag_id: TagId;
+};

package/dist/types/EditPost.d.ts

@@ -22,9 +22,9 @@ export type EditPost = {
      * 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;
+    scheduled_publish_time_at?: number;
+    tags?: Array<TagId>;
 };

package/dist/types/EditSite.d.ts

@@ -2,6 +2,7 @@ import type { CommentSortType } from "./CommentSortType";
 import type { FederationMode } from "./FederationMode";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
+import type { MultiCommunityId } from "./MultiCommunityId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
@@ -66,10 +67,6 @@ export type EditSite = {
      * 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.
      */
@@ -85,33 +82,38 @@ export type EditSite = {
     /**
      * The number of messages allowed in a given time frame.
      */
-    rate_limit_message?: number;
-    rate_limit_message_per_second?: number;
+    rate_limit_message_max_requests?: number;
+    rate_limit_message_interval_seconds?: number;
     /**
      * The number of posts allowed in a given time frame.
      */
-    rate_limit_post?: number;
-    rate_limit_post_per_second?: number;
+    rate_limit_post_max_requests?: number;
+    rate_limit_post_interval_seconds?: number;
     /**
      * The number of registrations allowed in a given time frame.
      */
-    rate_limit_register?: number;
-    rate_limit_register_per_second?: number;
+    rate_limit_register_max_requests?: number;
+    rate_limit_register_interval_seconds?: number;
     /**
      * The number of image uploads allowed in a given time frame.
      */
-    rate_limit_image?: number;
-    rate_limit_image_per_second?: number;
+    rate_limit_image_max_requests?: number;
+    rate_limit_image_interval_seconds?: number;
     /**
      * The number of comments allowed in a given time frame.
      */
-    rate_limit_comment?: number;
-    rate_limit_comment_per_second?: number;
+    rate_limit_comment_max_requests?: number;
+    rate_limit_comment_interval_seconds?: number;
     /**
      * The number of searches allowed in a given time frame.
      */
-    rate_limit_search?: number;
-    rate_limit_search_per_second?: number;
+    rate_limit_search_max_requests?: number;
+    rate_limit_search_interval_seconds?: number;
+    /**
+     * The number of settings imports or exports allowed in a given time frame.
+     */
+    rate_limit_import_user_settings_max_requests?: number;
+    rate_limit_import_user_settings_interval_seconds?: number;
     /**
      * Whether to enable federation.
      */
@@ -158,13 +160,16 @@ export type EditSite = {
      * 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;
     /**
      * Block NSFW content being created
      */
     disallow_nsfw_content?: boolean;
+    /**
+     * Dont send email notifications to users for new replies, mentions etc
+     */
+    disable_email_notifications?: boolean;
+    /**
+     * A multicommunity with suggested communities which is shown on the homepage
+     */
+    suggested_communities?: MultiCommunityId;
 };

package/dist/types/ExportDataResponse.d.ts

@@ -0,0 +1,13 @@
+import type { PostOrCommentOrPrivateMessage } from "./PostOrCommentOrPrivateMessage";
+import type { UserSettingsBackup } from "./UserSettingsBackup";
+/**
+ * Your exported data.
+ */
+export type ExportDataResponse = {
+    notifications: Array<PostOrCommentOrPrivateMessage>;
+    content: Array<PostOrCommentOrPrivateMessage>;
+    read_posts: Array<string>;
+    liked: Array<string>;
+    moderates: Array<string>;
+    settings: UserSettingsBackup;
+};

package/dist/types/FederationBlockList.d.ts

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

package/dist/types/FederationError.d.ts

@@ -7,4 +7,6 @@ export type FederationError = "InvalidCommunity" | "CannotCreatePostOrCommentInD
     DomainBlocked: string;
 } | {
     DomainNotInAllowList: string;
-} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | "PlatformLackingPrivateCommunitySupport" | "Unreachable";
+} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | {
+    InvalidFollow: string;
+} | "Unreachable";

package/dist/types/FollowMultiCommunity.d.ts

@@ -0,0 +1,5 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type FollowMultiCommunity = {
+    multi_community_id: MultiCommunityId;
+    follow: boolean;
+};

package/dist/types/GetComments.d.ts

@@ -2,6 +2,7 @@ import type { CommentId } from "./CommentId";
 import type { CommentSortType } from "./CommentSortType";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PostId } from "./PostId";
 /**
  * Get a list of comments.
@@ -15,12 +16,11 @@ export type GetComments = {
      */
     time_range_seconds?: number;
     max_depth?: number;
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
     community_id?: CommunityId;
     community_name?: string;
     post_id?: PostId;
     parent_id?: CommentId;
-    liked_only?: boolean;
-    disliked_only?: boolean;
 };

package/dist/types/GetCommentsResponse.d.ts

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

package/dist/types/GetCommentsSlimResponse.d.ts

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

package/dist/types/GetModlog.d.ts

@@ -2,7 +2,7 @@ import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { ModlogActionType } from "./ModlogActionType";
-import type { ModlogCombinedPaginationCursor } from "./ModlogCombinedPaginationCursor";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 /**
@@ -38,6 +38,7 @@ export type GetModlog = {
      * Filter by comment.
      */
     comment_id?: CommentId;
-    page_cursor?: ModlogCombinedPaginationCursor;
+    page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/GetModlogResponse.d.ts

@@ -1,7 +1,13 @@
 import type { ModlogCombinedView } from "./ModlogCombinedView";
+import type { PaginationCursor } from "./PaginationCursor";
 /**
  * The modlog fetch response.
  */
 export type GetModlogResponse = {
     modlog: Array<ModlogCombinedView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/GetMultiCommunity.d.ts

@@ -0,0 +1,4 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type GetMultiCommunity = {
+    id: MultiCommunityId;
+};

package/dist/types/GetMultiCommunityResponse.d.ts

@@ -0,0 +1,6 @@
+import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
+export type GetMultiCommunityResponse = {
+    multi_community_view: MultiCommunityView;
+    communities: Array<CommunityView>;
+};

package/dist/types/GetPosts.d.ts

@@ -1,5 +1,6 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { MultiCommunityId } from "./MultiCommunityId";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PostSortType } from "./PostSortType";
 /**
@@ -14,17 +15,9 @@ export type GetPosts = {
      * Use Zero to override the local_site and local_user time_range.
      */
     time_range_seconds?: number;
-    /**
-     * 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;
+    multi_community_id?: MultiCommunityId;
     show_hidden?: boolean;
     /**
      * If true, then show the read posts (even if your user setting is to hide them)
@@ -48,4 +41,5 @@ export type GetPosts = {
     no_comments_only?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/GetPostsResponse.d.ts

@@ -9,4 +9,5 @@ export type GetPostsResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/GetSiteResponse.d.ts

@@ -3,6 +3,7 @@ import type { LanguageId } from "./LanguageId";
 import type { LocalSiteUrlBlocklist } from "./LocalSiteUrlBlocklist";
 import type { OAuthProvider } from "./OAuthProvider";
 import type { PersonView } from "./PersonView";
+import type { PluginMetadata } from "./PluginMetadata";
 import type { PublicOAuthProvider } from "./PublicOAuthProvider";
 import type { SiteView } from "./SiteView";
 import type { Tagline } from "./Tagline";
@@ -22,8 +23,9 @@ export type GetSiteResponse = {
     /**
      * A list of external auth methods your site supports.
      */
-    oauth_providers?: Array<PublicOAuthProvider>;
-    admin_oauth_providers?: Array<OAuthProvider>;
+    oauth_providers: Array<PublicOAuthProvider>;
+    admin_oauth_providers: Array<OAuthProvider>;
     blocked_urls: Array<LocalSiteUrlBlocklist>;
     image_upload_disabled: boolean;
+    active_plugins: Array<PluginMetadata>;
 };

package/dist/types/Instance.d.ts

@@ -1,12 +1,22 @@
 import type { InstanceId } from "./InstanceId";
 /**
- * A federated instance / site.
+ * Basic data about a Fediverse instance which is available for every known domain. Additional
+ * data may be available in [[Site]].
  */
 export type Instance = {
     id: InstanceId;
     domain: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    /**
+     * When the instance was updated.
+     */
+    updated_at?: string;
+    /**
+     * The software of the instance.
+     */
     software?: string;
+    /**
+     * The version of the instance's software.
+     */
     version?: string;
 };

package/dist/types/InstanceActions.d.ts

@@ -0,0 +1,18 @@
+export type InstanceActions = {
+    /**
+     * When the instance's communities were blocked.
+     */
+    blocked_communities_at?: string;
+    /**
+     * When this user received a site ban.
+     */
+    received_ban_at?: string;
+    /**
+     * When their ban expires.
+     */
+    ban_expires_at?: string;
+    /**
+     * When the instance's persons were blocked.
+     */
+    blocked_persons_at?: string;
+};

package/dist/types/InstanceWithFederationState.d.ts

@@ -8,8 +8,17 @@ export type InstanceWithFederationState = {
     federation_state?: ReadableFederationState;
     id: InstanceId;
     domain: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    /**
+     * When the instance was updated.
+     */
+    updated_at?: string;
+    /**
+     * The software of the instance.
+     */
     software?: string;
+    /**
+     * The version of the instance's software.
+     */
     version?: string;
 };