lemmy-js-client 1.0.0-block-nsfw.1 → 1.0.0-bool-vote.1

package/dist/types/PendingFollow.d.ts

@@ -1,9 +1,9 @@
 import type { Community } from "./Community";
+import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { Person } from "./Person";
-import type { SubscribedType } from "./SubscribedType";
 export type PendingFollow = {
     person: Person;
     community: Community;
     is_new_instance: boolean;
-    subscribed: SubscribedType;
+    follow_state?: CommunityFollowerState;
 };

package/dist/types/Person.d.ts

@@ -15,12 +15,8 @@ export type Person = {
      * A URL for an avatar.
      */
     avatar?: DbUrl;
-    /**
-     * Whether the person is banned.
-     */
-    banned: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * The federated ap_id.
      */
@@ -49,9 +45,7 @@ export type Person = {
      * Whether the person is a bot account.
      */
     bot_account: boolean;
-    /**
-     * When their ban, if it exists, expires, if at all.
-     */
-    ban_expires?: string;
     instance_id: InstanceId;
+    post_count: number;
+    comment_count: number;
 };

package/dist/types/PersonActions.d.ts

@@ -0,0 +1,26 @@
+export type PersonActions = {
+    /**
+     * When the person was blocked.
+     */
+    blocked_at?: string;
+    /**
+     * When the person was noted.
+     */
+    noted_at?: string;
+    /**
+     * A note about the person.
+     */
+    note?: string;
+    /**
+     * When the person was voted on.
+     */
+    voted_at?: string;
+    /**
+     * A total of upvotes given to this person
+     */
+    upvotes?: number;
+    /**
+     * A total of downvotes given to this person
+     */
+    downvotes?: number;
+};

package/dist/types/PersonLikedCombinedView.d.ts

@@ -0,0 +1,7 @@
+import type { CommentView } from "./CommentView";
+import type { PostView } from "./PostView";
+export type PersonLikedCombinedView = ({
+    type_: "Post";
+} & PostView) | ({
+    type_: "Comment";
+} & CommentView);

package/dist/types/PersonLikedCombinedView.js

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

package/dist/types/PersonResponse.d.ts

@@ -0,0 +1,7 @@
+import type { PersonView } from "./PersonView";
+/**
+ * A person response for actions done to a person.
+ */
+export type PersonResponse = {
+    person_view: PersonView;
+};

package/dist/types/PersonResponse.js

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

package/dist/types/PersonSavedCombinedView.d.ts

@@ -0,0 +1,7 @@
+import type { CommentView } from "./CommentView";
+import type { PostView } from "./PostView";
+export type PersonSavedCombinedView = ({
+    type_: "Post";
+} & PostView) | ({
+    type_: "Comment";
+} & CommentView);

package/dist/types/PersonSavedCombinedView.js

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

package/dist/types/PersonView.d.ts

@@ -1,10 +1,12 @@
 import type { Person } from "./Person";
-import type { PersonAggregates } from "./PersonAggregates";
+import type { PersonActions } from "./PersonActions";
 /**
  * A person view.
  */
 export type PersonView = {
     person: Person;
-    counts: PersonAggregates;
     is_admin: boolean;
+    person_actions?: PersonActions;
+    banned: boolean;
+    ban_expires_at?: string;
 };

package/dist/types/PluginMetadata.d.ts

@@ -0,0 +1,5 @@
+export type PluginMetadata = {
+    name: string;
+    url: string;
+    description: string;
+};

package/dist/types/Post.d.ts

@@ -27,8 +27,8 @@ export type Post = {
      * Whether the post is locked.
      */
     locked: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * Whether the post is deleted.
      */
@@ -78,5 +78,22 @@ export type Post = {
     /**
      * Time at which the post will be published. None means publish immediately.
      */
-    scheduled_publish_time?: string;
+    scheduled_publish_time_at?: string;
+    /**
+     * The time of the newest comment in the post, if the post has any comments.
+     */
+    newest_comment_time_at?: string;
+    comments: number;
+    score: number;
+    upvotes: number;
+    downvotes: number;
+    report_count: number;
+    unresolved_report_count: number;
+    /**
+     * If a local user posts in a remote community, the comment is hidden until it is confirmed
+     * accepted by the community (by receiving it back via federation).
+     */
+    federation_pending: boolean;
+    embed_video_width?: number;
+    embed_video_height?: number;
 };

package/dist/types/PostActions.d.ts

@@ -0,0 +1,33 @@
+import type { PostNotificationsMode } from "./PostNotificationsMode";
+export type PostActions = {
+    /**
+     * When the post was read.
+     */
+    read_at?: string;
+    /**
+     * When was the last time you read the comments.
+     */
+    read_comments_at?: string;
+    /**
+     * When the post was saved.
+     */
+    saved_at?: string;
+    /**
+     * When the post was upvoted or downvoted.
+     */
+    voted_at?: string;
+    /**
+     * When the post was hidden.
+     */
+    hidden_at?: string;
+    /**
+     * The number of comments you read last. Subtract this from total comments to get an unread
+     * count.
+     */
+    read_comments_amount?: number;
+    /**
+     * True if upvoted, false if downvoted. Upvote is greater than downvote.
+     */
+    vote_is_upvote?: boolean;
+    notifications?: PostNotificationsMode;
+};

package/dist/types/PostActions.js

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

package/dist/types/PostNotificationsMode.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Available settings for post notifications
+ */
+export type PostNotificationsMode = "AllComments" | "RepliesAndMentions" | "Mute";

package/dist/types/PostOrCommentOrPrivateMessage.d.ts

@@ -0,0 +1,10 @@
+import type { Comment } from "./Comment";
+import type { Post } from "./Post";
+import type { PrivateMessage } from "./PrivateMessage";
+export type PostOrCommentOrPrivateMessage = ({
+    type_: "Post";
+} & Post) | ({
+    type_: "Comment";
+} & Comment) | ({
+    type_: "PrivateMessage";
+} & PrivateMessage);

package/dist/types/PostOrCommentOrPrivateMessage.js

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

package/dist/types/PostReport.d.ts

@@ -24,7 +24,7 @@ export type PostReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     violates_instance_rules: boolean;
 };

package/dist/types/PostReportView.d.ts

@@ -1,9 +1,10 @@
 import type { Community } from "./Community";
+import type { CommunityActions } from "./CommunityActions";
 import type { Person } from "./Person";
+import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
+import type { PostActions } from "./PostActions";
 import type { PostReport } from "./PostReport";
-import type { SubscribedType } from "./SubscribedType";
 /**
  * A post report view.
  */
@@ -13,19 +14,14 @@ export type PostReportView = {
     community: Community;
     creator: Person;
     post_creator: Person;
-    creator_banned_from_community: boolean;
-    creator_is_moderator: boolean;
-    creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    counts: PostAggregates;
+    community_actions?: CommunityActions;
+    post_actions?: PostActions;
+    person_actions?: PersonActions;
     resolver?: Person;
+    creator_is_admin: boolean;
+    creator_is_moderator: boolean;
+    creator_banned: boolean;
+    creator_ban_expires_at?: string;
+    creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };

package/dist/types/PostView.d.ts

@@ -1,10 +1,11 @@
 import type { Community } from "./Community";
+import type { CommunityActions } from "./CommunityActions";
 import type { ImageDetails } from "./ImageDetails";
 import type { Person } from "./Person";
+import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
-import type { PostTags } from "./PostTags";
-import type { SubscribedType } from "./SubscribedType";
+import type { PostActions } from "./PostActions";
+import type { TagsView } from "./TagsView";
 /**
  * A post view.
  */
@@ -13,21 +14,15 @@ export type PostView = {
     creator: Person;
     community: Community;
     image_details?: ImageDetails;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
+    community_actions?: CommunityActions;
+    person_actions?: PersonActions;
+    post_actions?: PostActions;
     creator_is_admin: boolean;
-    counts: PostAggregates;
-    subscribed: SubscribedType;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    tags: PostTags;
+    tags: TagsView;
     can_mod: boolean;
+    creator_banned: boolean;
+    creator_ban_expires_at?: string;
+    creator_is_moderator: boolean;
+    creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };

package/dist/types/PrivateMessage.d.ts

@@ -10,9 +10,8 @@ export type PrivateMessage = {
     recipient_id: PersonId;
     content: string;
     deleted: boolean;
-    read: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     ap_id: DbUrl;
     local: boolean;
     removed: boolean;

package/dist/types/PrivateMessageReport.d.ts

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

package/dist/types/PrivateMessageReportView.d.ts

@@ -7,7 +7,10 @@ import type { PrivateMessageReport } from "./PrivateMessageReport";
 export type PrivateMessageReportView = {
     private_message_report: PrivateMessageReport;
     private_message: PrivateMessage;
-    private_message_creator: Person;
     creator: Person;
+    private_message_creator: Person;
     resolver?: Person;
+    creator_is_admin: boolean;
+    creator_banned: boolean;
+    creator_ban_expires_at?: string;
 };

package/dist/types/PurgeComment.d.ts

@@ -4,5 +4,5 @@ import type { CommentId } from "./CommentId";
  */
 export type PurgeComment = {
     comment_id: CommentId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgeCommunity.d.ts

@@ -4,5 +4,5 @@ import type { CommunityId } from "./CommunityId";
  */
 export type PurgeCommunity = {
     community_id: CommunityId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePerson.d.ts

@@ -4,5 +4,5 @@ import type { PersonId } from "./PersonId";
  */
 export type PurgePerson = {
     person_id: PersonId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePost.d.ts

@@ -4,5 +4,5 @@ import type { PostId } from "./PostId";
  */
 export type PurgePost = {
     post_id: PostId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/ReadableFederationState.d.ts

@@ -4,13 +4,13 @@ export type ReadableFederationState = {
     /**
      * timestamp of the next retry attempt (null if fail count is 0)
      */
-    next_retry?: string;
+    next_retry_at?: string;
     instance_id: InstanceId;
     /**
      * the last successfully sent activity id
      */
     last_successful_id?: ActivityId;
-    last_successful_published_time?: string;
+    last_successful_published_time_at?: string;
     /**
      * how many failed attempts have been made to send the next activity
      */
@@ -18,5 +18,5 @@ export type ReadableFederationState = {
     /**
      * timestamp of the last retry attempt (when the last failing activity was resent)
      */
-    last_retry?: string;
+    last_retry_at?: string;
 };

package/dist/types/RegistrationApplication.d.ts

@@ -10,5 +10,5 @@ export type RegistrationApplication = {
     answer: string;
     admin_id?: PersonId;
     deny_reason?: string;
-    published: string;
+    published_at: string;
 };

package/dist/types/RemoveComment.d.ts

@@ -5,5 +5,5 @@ import type { CommentId } from "./CommentId";
 export type RemoveComment = {
     comment_id: CommentId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemoveCommunity.d.ts

@@ -5,5 +5,5 @@ import type { CommunityId } from "./CommunityId";
 export type RemoveCommunity = {
     community_id: CommunityId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemovePost.d.ts

@@ -5,5 +5,5 @@ import type { PostId } from "./PostId";
 export type RemovePost = {
     post_id: PostId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/ResolveCommunityReport.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityReportId } from "./CommunityReportId";
+/**
+ * Resolve a community report.
+ */
+export type ResolveCommunityReport = {
+    report_id: CommunityReportId;
+    resolved: boolean;
+};

package/dist/types/ResolveCommunityReport.js

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

package/dist/types/SaveUserSettings.d.ts

@@ -4,6 +4,7 @@ import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { SensitiveString } from "./SensitiveString";
+import type { VoteShow } from "./VoteShow";
 /**
  * Saves settings for your user.
  */
@@ -36,6 +37,10 @@ export type SaveUserSettings = {
      * A default time range limit to apply to post sorts, in seconds. 0 means none.
      */
     default_post_time_range_seconds?: number;
+    /**
+     * A default fetch limit for number of items returned.
+     */
+    default_items_per_page?: number;
     /**
      * The default comment sort, usually "hot"
      */
@@ -84,6 +89,7 @@ export type SaveUserSettings = {
      * A list of languages you are able to see discussion in.
      */
     discussion_languages?: Array<LanguageId>;
+    blocking_keywords?: Array<string>;
     /**
      * Open links in a new tab
      */
@@ -92,10 +98,6 @@ export type SaveUserSettings = {
      * Enable infinite scroll
      */
     infinite_scroll_enabled?: boolean;
-    /**
-     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
-     */
-    enable_keyboard_navigation?: boolean;
     /**
      * Whether user avatars or inline images in the UI that are gifs should be allowed to play or
      * should be paused
@@ -112,9 +114,9 @@ export type SaveUserSettings = {
     /**
      * Some vote display mode settings
      */
-    show_scores?: boolean;
+    show_score?: boolean;
     show_upvotes?: boolean;
-    show_downvotes?: boolean;
+    show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;
     /**
      * Whether to automatically mark fetched posts as read.
@@ -124,4 +126,8 @@ export type SaveUserSettings = {
      * Whether to hide posts containing images/videos.
      */
     hide_media?: boolean;
+    /**
+     * Whether to show vote totals given to others.
+     */
+    show_person_votes?: boolean;
 };

package/dist/types/Search.d.ts

@@ -1,14 +1,14 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonId } from "./PersonId";
-import type { SearchCombinedPaginationCursor } from "./SearchCombinedPaginationCursor";
 import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
 /**
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    search_term?: string;
+    q: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
@@ -24,6 +24,11 @@ export type Search = {
     post_url_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-    page_cursor?: SearchCombinedPaginationCursor;
+    /**
+     * If true, then show the nsfw posts (even if your user setting is to hide them)
+     */
+    show_nsfw?: boolean;
+    page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/SearchCombinedView.d.ts

@@ -1,5 +1,6 @@
 import type { CommentView } from "./CommentView";
 import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 export type SearchCombinedView = ({
@@ -10,4 +11,6 @@ export type SearchCombinedView = ({
     type_: "Community";
 } & CommunityView) | ({
     type_: "Person";
-} & PersonView);
+} & PersonView) | ({
+    type_: "MultiCommunity";
+} & MultiCommunityView);

package/dist/types/SearchResponse.d.ts

@@ -1,7 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { SearchCombinedView } from "./SearchCombinedView";
 /**
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
     results: Array<SearchCombinedView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/SearchType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The type of content returned from a search.
  */
-export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users";
+export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users" | "MultiCommunities";

package/dist/types/Site.d.ts

@@ -2,7 +2,8 @@ import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { SiteId } from "./SiteId";
 /**
- * The site.
+ * Additional data for federated instances. This may be missing for other platforms which are not
+ * fully compatible. Basic data is guaranteed to be available via [[Instance]].
  */
 export type Site = {
     id: SiteId;
@@ -11,8 +12,8 @@ export type Site = {
      * A sidebar for the site in markdown.
      */
     sidebar?: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * An icon URL.
      */

package/dist/types/SiteResponse.d.ts

@@ -4,8 +4,4 @@ import type { SiteView } from "./SiteView";
  */
 export type SiteResponse = {
     site_view: SiteView;
-    /**
-     * deprecated, use field `tagline` or /api/v4/tagline/list
-     */
-    taglines: Array<null>;
 };

package/dist/types/SiteView.d.ts

@@ -1,7 +1,7 @@
+import type { Instance } from "./Instance";
 import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
-import type { SiteAggregates } from "./SiteAggregates";
 /**
  * A site view.
  */
@@ -9,5 +9,5 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
-    counts: SiteAggregates;
+    instance: Instance;
 };