lemmy-js-client 1.0.0-search-query-mandatory.1 → 1.0.0-search-resolve-field.0

package/dist/types/MultiCommunityFollow.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { MultiCommunityId } from "./MultiCommunityId";
+import type { PersonId } from "./PersonId";
+export type MultiCommunityFollow = {
+    multi_community_id: MultiCommunityId;
+    person_id: PersonId;
+    follow_state: CommunityFollowerState;
+};

package/dist/types/MultiCommunityId.d.ts

@@ -0,0 +1 @@
+export type MultiCommunityId = number;

package/dist/types/MultiCommunityListingType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A listing type for multi-community fetches.
+ */
+export type MultiCommunityListingType = "all" | "local" | "subscribed";

package/dist/types/MultiCommunityResponse.d.ts

@@ -0,0 +1,4 @@
+import type { MultiCommunityView } from "./MultiCommunityView";
+export type MultiCommunityResponse = {
+    multi_community_view: MultiCommunityView;
+};

package/dist/types/MultiCommunitySortType.d.ts

@@ -0,0 +1 @@
+export type MultiCommunitySortType = "new" | "old" | "name_asc" | "name_desc" | "communities" | "subscribers" | "subscribers_local";

package/dist/types/MultiCommunityView.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { MultiCommunity } from "./MultiCommunity";
+import type { Person } from "./Person";
+export type MultiCommunityView = {
+    multi: MultiCommunity;
+    follow_state?: CommunityFollowerState;
+    owner: Person;
+};

package/dist/types/MyUserInfo.d.ts

@@ -4,6 +4,7 @@ import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { Instance } from "./Instance";
 import type { LanguageId } from "./LanguageId";
 import type { LocalUserView } from "./LocalUserView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { Person } from "./Person";
 /**
  * Your user info.
@@ -12,8 +13,10 @@ export type MyUserInfo = {
     local_user_view: LocalUserView;
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
+    multi_community_follows: Array<MultiCommunityView>;
     community_blocks: Array<Community>;
-    instance_blocks: Array<Instance>;
+    instance_communities_blocks: Array<Instance>;
+    instance_persons_blocks: Array<Instance>;
     person_blocks: Array<Person>;
     keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;

package/dist/types/NotePerson.d.ts

@@ -0,0 +1,10 @@
+import type { PersonId } from "./PersonId";
+/**
+ * Make a note for a person.
+ *
+ * An empty string deletes the note.
+ */
+export type NotePerson = {
+    person_id: PersonId;
+    note: string;
+};

package/dist/types/Notification.d.ts

@@ -0,0 +1,18 @@
+import type { CommentId } from "./CommentId";
+import type { ModlogId } from "./ModlogId";
+import type { NotificationId } from "./NotificationId";
+import type { NotificationType } from "./NotificationType";
+import type { PersonId } from "./PersonId";
+import type { PostId } from "./PostId";
+import type { PrivateMessageId } from "./PrivateMessageId";
+export type Notification = {
+    id: NotificationId;
+    recipient_id: PersonId;
+    comment_id?: CommentId;
+    read: boolean;
+    published_at: string;
+    kind: NotificationType;
+    post_id?: PostId;
+    private_message_id?: PrivateMessageId;
+    modlog_id?: ModlogId;
+};

package/dist/types/NotificationData.d.ts

@@ -0,0 +1,13 @@
+import type { CommentView } from "./CommentView";
+import type { ModlogView } from "./ModlogView";
+import type { PostView } from "./PostView";
+import type { PrivateMessageView } from "./PrivateMessageView";
+export type NotificationData = ({
+    type_: "comment";
+} & CommentView) | ({
+    type_: "post";
+} & PostView) | ({
+    type_: "private_message";
+} & PrivateMessageView) | ({
+    type_: "mod_action";
+} & ModlogView);

package/dist/types/NotificationDataType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for the inbox.
+ */
+export type NotificationDataType = "all" | "reply" | "mention" | "private_message" | "subscribed" | "mod_action";

package/dist/types/NotificationId.d.ts

@@ -0,0 +1 @@
+export type NotificationId = number;

package/dist/types/NotificationType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Types of notifications which can be received in inbox
+ */
+export type NotificationType = "mention" | "reply" | "subscribed" | "private_message" | "mod_action";

package/dist/types/NotificationView.d.ts

@@ -0,0 +1,6 @@
+import type { Notification } from "./Notification";
+import type { NotificationData } from "./NotificationData";
+export type NotificationView = {
+    notification: Notification;
+    data: NotificationData;
+};

package/dist/types/OpenGraphData.d.ts

@@ -6,5 +6,9 @@ export type OpenGraphData = {
     title?: string;
     description?: string;
     image?: DbUrl;
+    image_width?: number;
+    image_height?: number;
     embed_video_url?: DbUrl;
+    video_width?: number;
+    video_height?: number;
 };

package/dist/types/PendingFollowerView.d.ts

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

package/dist/types/PersonActions.d.ts

@@ -3,4 +3,24 @@ 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/PersonContentCombinedView.d.ts

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

package/dist/types/PersonContentType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for a person's content.
  */
-export type PersonContentType = "All" | "Comments" | "Posts";
+export type PersonContentType = "all" | "comments" | "posts";

package/dist/types/PersonLikedCombinedView.d.ts

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

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/PersonSavedCombinedView.d.ts

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

package/dist/types/PersonView.d.ts

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

package/dist/types/Post.d.ts

@@ -79,14 +79,14 @@ export type Post = {
      * Time at which the post will be published. None means publish immediately.
      */
     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;
-    /**
-     * The time of the newest comment in the post.
-     */
-    newest_comment_time_at: string;
     report_count: number;
     unresolved_report_count: number;
     /**
@@ -94,4 +94,6 @@ export type Post = {
      * 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

@@ -1,3 +1,4 @@
+import type { PostNotificationsMode } from "./PostNotificationsMode";
 export type PostActions = {
     /**
      * When the post was read.
@@ -7,25 +8,26 @@ export type PostActions = {
      * When was the last time you read the comments.
      */
     read_comments_at?: string;
-    /**
-     * The number of comments you read last. Subtract this from total comments to get an unread
-     * count.
-     */
-    read_comments_amount?: number;
     /**
      * When the post was saved.
      */
     saved_at?: string;
     /**
-     * When the post was liked.
-     */
-    liked_at?: string;
-    /**
-     * The like / score of the post.
+     * When the post was upvoted or downvoted.
      */
-    like_score?: number;
+    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

@@ -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/PostFeatureType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The feature type for a post.
  */
-export type PostFeatureType = "Local" | "Community";
+export type PostFeatureType = "local" | "community";

package/dist/types/PostListingMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * A post-view mode that changes how multiple post listings look.
  */
-export type PostListingMode = "List" | "Card" | "SmallCard";
+export type PostListingMode = "list" | "card" | "small_card";

package/dist/types/PostNotificationsMode.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Available settings for post notifications
+ */
+export type PostNotificationsMode = "all_comments" | "replies_and_mentions" | "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_: "private_message";
+} & PrivateMessage);

package/dist/types/PostReportView.d.ts

@@ -14,10 +14,14 @@ export type PostReportView = {
     community: Community;
     creator: Person;
     post_creator: Person;
-    creator_community_actions?: CommunityActions;
     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/PostSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
  */
-export type PostSortType = "Active" | "Hot" | "New" | "Old" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";
+export type PostSortType = "active" | "hot" | "new" | "old" | "top" | "most_comments" | "new_comments" | "controversial" | "scaled";

package/dist/types/PostView.d.ts

@@ -1,7 +1,6 @@
 import type { Community } from "./Community";
 import type { CommunityActions } from "./CommunityActions";
 import type { ImageDetails } from "./ImageDetails";
-import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
@@ -18,12 +17,12 @@ export type PostView = {
     community_actions?: CommunityActions;
     person_actions?: PersonActions;
     post_actions?: PostActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
     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,7 +10,6 @@ export type PrivateMessage = {
     recipient_id: PersonId;
     content: string;
     deleted: boolean;
-    read: boolean;
     published_at: string;
     updated_at?: string;
     ap_id: DbUrl;

package/dist/types/PrivateMessageReportView.d.ts

@@ -10,4 +10,7 @@ export type PrivateMessageReportView = {
     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,7 +4,7 @@ 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

package/dist/types/Register.d.ts

@@ -27,4 +27,8 @@ export type Register = {
      * An answer is mandatory if require application is enabled on the server
      */
     answer?: string;
+    /**
+     * If this is true the login is valid forever, otherwise it expires after one week.
+     */
+    stay_logged_in?: boolean;
 };

package/dist/types/RegistrationApplication.d.ts

@@ -11,4 +11,5 @@ export type RegistrationApplication = {
     admin_id?: PersonId;
     deny_reason?: string;
     published_at: string;
+    updated_at?: string;
 };

package/dist/types/RegistrationMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * The registration mode for your site. Determines what happens after a user signs up.
  */
-export type RegistrationMode = "Closed" | "RequireApplication" | "Open";
+export type RegistrationMode = "closed" | "require_application" | "open";

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/ReportCombinedView.d.ts

@@ -3,11 +3,11 @@ import type { CommunityReportView } from "./CommunityReportView";
 import type { PostReportView } from "./PostReportView";
 import type { PrivateMessageReportView } from "./PrivateMessageReportView";
 export type ReportCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostReportView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentReportView) | ({
-    type_: "PrivateMessage";
+    type_: "private_message";
 } & PrivateMessageReportView) | ({
-    type_: "Community";
+    type_: "community";
 } & CommunityReportView);

package/dist/types/ReportType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for reports.
  */
-export type ReportType = "All" | "Posts" | "Comments" | "PrivateMessages" | "Communities";
+export type ReportType = "all" | "posts" | "comments" | "private_messages" | "communities";

package/dist/types/SaveUserSettings.d.ts

@@ -37,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"
      */
@@ -94,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
@@ -114,7 +114,7 @@ export type SaveUserSettings = {
     /**
      * Some vote display mode settings
      */
-    show_scores?: boolean;
+    show_score?: boolean;
     show_upvotes?: boolean;
     show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;
@@ -126,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

@@ -8,7 +8,11 @@ import type { SearchType } from "./SearchType";
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    q?: string;
+    /**
+     * The search query. Can be a plain text, or an object ID which will be resolved
+     * (eg `https://lemmy.world/comment/1` or `!fediverse@lemmy.ml`).
+     */
+    q: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;

package/dist/types/SearchCombinedView.d.ts

@@ -1,13 +1,16 @@
 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 = ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentView) | ({
-    type_: "Community";
+    type_: "community";
 } & CommunityView) | ({
-    type_: "Person";
-} & PersonView);
+    type_: "person";
+} & PersonView) | ({
+    type_: "multi_community";
+} & MultiCommunityView);

package/dist/types/SearchResponse.d.ts

@@ -4,7 +4,16 @@ import type { SearchCombinedView } from "./SearchCombinedView";
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
-    results: Array<SearchCombinedView>;
+    /**
+     * If `Search.q` contains an ActivityPub ID (eg `https://lemmy.world/comment/1`) or an
+     * identifier (eg `!fediverse@lemmy.ml`) then this field contains the resolved object.
+     * It should always be shown above other search results.
+     */
+    resolve?: SearchCombinedView;
+    /**
+     * Items which contain the search string in post body, comment text, community sidebar etc.
+     */
+    search: Array<SearchCombinedView>;
     /**
      * the pagination cursor to use to fetch the next page
      */

package/dist/types/SearchSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The search sort types.
  */
-export type SearchSortType = "New" | "Top" | "Old";
+export type SearchSortType = "new" | "top" | "old";