lemmy-js-client 0.20.0-modlog-combined.1 → 0.20.0-move-community-hidden.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -4
- package/dist/http.d.ts +189 -466
- package/dist/http.js +1109 -418
- package/dist/index.d.ts +20 -18
- package/dist/other_types.d.ts +81 -0
- package/dist/types/Comment.d.ts +9 -0
- package/dist/types/CommentReplyView.d.ts +5 -3
- package/dist/types/CommentReport.d.ts +1 -0
- package/dist/types/CommentReportView.d.ts +4 -3
- package/dist/types/CommentSlimView.d.ts +22 -0
- package/dist/types/CommentView.d.ts +5 -3
- package/dist/types/Community.d.ts +24 -2
- package/dist/types/CommunityReportView.d.ts +0 -2
- package/dist/types/CommunitySortType.d.ts +1 -1
- package/dist/types/CommunityView.d.ts +1 -2
- package/dist/types/CommunityVisibility.d.ts +1 -1
- package/dist/types/CreateCommentReport.d.ts +1 -0
- package/dist/types/CreatePostReport.d.ts +1 -0
- package/dist/types/CreateSite.d.ts +2 -0
- package/dist/types/DeleteImageParams.d.ts +0 -1
- package/dist/types/EditSite.d.ts +13 -0
- package/dist/types/FederationError.d.ts +1 -1
- package/dist/types/GetComments.d.ts +5 -0
- package/dist/types/GetCommentsSlimResponse.d.ts +7 -0
- package/dist/types/GetModlog.d.ts +24 -0
- package/dist/types/GetPostResponse.d.ts +0 -2
- package/dist/types/GetPosts.d.ts +10 -0
- package/dist/types/GetRandomCommunity.d.ts +1 -0
- package/dist/types/GetSiteResponse.d.ts +2 -2
- package/dist/types/GetUnreadCountResponse.d.ts +2 -4
- package/dist/types/ImageDetails.d.ts +1 -0
- package/dist/types/InboxCombinedPaginationCursor.d.ts +4 -0
- package/dist/types/InboxCombinedView.d.ts +13 -0
- package/dist/types/InboxDataType.d.ts +4 -0
- package/dist/types/LemmyErrorType.d.ts +1 -1
- package/dist/types/ListCommunities.d.ts +5 -0
- package/dist/types/ListInbox.d.ts +11 -0
- package/dist/types/ListInboxResponse.d.ts +7 -0
- package/dist/types/ListReports.d.ts +18 -0
- package/dist/types/LocalImage.d.ts +0 -1
- package/dist/types/LocalSite.d.ts +33 -0
- package/dist/types/LocalUser.d.ts +17 -0
- package/dist/types/LocalUserView.d.ts +0 -4
- package/dist/types/MarkPersonCommentMentionAsRead.d.ts +8 -0
- package/dist/types/MarkPersonPostMentionAsRead.d.ts +8 -0
- package/dist/types/ModChangeCommunityVisibility.d.ts +12 -0
- package/dist/types/ModChangeCommunityVisibilityId.d.ts +1 -0
- package/dist/types/ModChangeCommunityVisibilityId.js +3 -0
- package/dist/types/ModChangeCommunityVisibilityView.d.ts +11 -0
- package/dist/types/Person.d.ts +4 -2
- package/dist/types/{PersonMention.d.ts → PersonCommentMention.d.ts} +3 -3
- package/dist/types/PersonCommentMentionId.d.ts +4 -0
- package/dist/types/PersonCommentMentionId.js +3 -0
- package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts} +9 -7
- package/dist/types/PersonContentType.d.ts +1 -1
- package/dist/types/PersonPostMention.d.ts +13 -0
- package/dist/types/PersonPostMentionId.d.ts +4 -0
- package/dist/types/PersonPostMentionId.js +3 -0
- package/dist/types/PersonPostMentionView.d.ts +34 -0
- package/dist/types/PersonSavedCombinedView.d.ts +7 -0
- package/dist/types/PersonView.d.ts +0 -2
- package/dist/types/Post.d.ts +10 -0
- package/dist/types/PostPaginationCursor.d.ts +7 -0
- package/dist/types/PostPaginationCursor.js +3 -0
- package/dist/types/PostReport.d.ts +1 -0
- package/dist/types/PostReportView.d.ts +4 -3
- package/dist/types/PostSortType.d.ts +1 -1
- package/dist/types/PostView.d.ts +5 -3
- package/dist/types/PrivateMessage.d.ts +1 -0
- package/dist/types/ReportType.d.ts +4 -0
- package/dist/types/ReportType.js +3 -0
- package/dist/types/ResendVerificationEmail.d.ts +7 -0
- package/dist/types/SaveUserSettings.d.ts +8 -0
- package/dist/types/Search.d.ts +12 -6
- package/dist/types/SearchCombinedPaginationCursor.d.ts +4 -0
- package/dist/types/SearchCombinedPaginationCursor.js +3 -0
- package/dist/types/SearchCombinedView.d.ts +13 -0
- package/dist/types/SearchResponse.d.ts +2 -10
- package/dist/types/SearchSortType.d.ts +4 -0
- package/dist/types/SearchSortType.js +3 -0
- package/dist/types/Site.d.ts +2 -2
- package/dist/types/SiteView.d.ts +0 -2
- package/dist/types/SuccessResponse.d.ts +1 -1
- package/dist/types/UploadImageResponse.d.ts +0 -1
- package/package.json +9 -4
- package/dist/types/CommentAggregates.d.ts +0 -17
- package/dist/types/CommentReplyResponse.d.ts +0 -7
- package/dist/types/CommunityAggregates.d.ts +0 -30
- package/dist/types/GetPersonMentions.d.ts +0 -10
- package/dist/types/GetPersonMentionsResponse.d.ts +0 -7
- package/dist/types/GetPrivateMessages.d.ts +0 -10
- package/dist/types/GetReplies.d.ts +0 -10
- package/dist/types/GetRepliesResponse.d.ts +0 -7
- package/dist/types/LocalUserVoteDisplayMode.d.ts +0 -9
- package/dist/types/MarkPersonMentionAsRead.d.ts +0 -8
- package/dist/types/PersonAggregates.d.ts +0 -9
- package/dist/types/PersonMentionId.d.ts +0 -4
- package/dist/types/PersonMentionResponse.d.ts +0 -7
- package/dist/types/PostAggregates.d.ts +0 -18
- package/dist/types/PrivateMessagesResponse.d.ts +0 -7
- package/dist/types/SiteAggregates.d.ts +0 -27
- /package/dist/types/{CommentAggregates.js → CommentSlimView.js} +0 -0
- /package/dist/types/{CommentReplyResponse.js → GetCommentsSlimResponse.js} +0 -0
- /package/dist/types/{LocalUserVoteDisplayMode.js → InboxCombinedPaginationCursor.js} +0 -0
- /package/dist/types/{CommunityAggregates.js → InboxCombinedView.js} +0 -0
- /package/dist/types/{PersonMentionId.js → InboxDataType.js} +0 -0
- /package/dist/types/{GetPersonMentions.js → ListInbox.js} +0 -0
- /package/dist/types/{GetPersonMentionsResponse.js → ListInboxResponse.js} +0 -0
- /package/dist/types/{GetPrivateMessages.js → MarkPersonCommentMentionAsRead.js} +0 -0
- /package/dist/types/{GetReplies.js → MarkPersonPostMentionAsRead.js} +0 -0
- /package/dist/types/{GetRepliesResponse.js → ModChangeCommunityVisibility.js} +0 -0
- /package/dist/types/{MarkPersonMentionAsRead.js → ModChangeCommunityVisibilityView.js} +0 -0
- /package/dist/types/{PersonAggregates.js → PersonCommentMention.js} +0 -0
- /package/dist/types/{PersonMention.js → PersonCommentMentionView.js} +0 -0
- /package/dist/types/{PersonMentionResponse.js → PersonPostMention.js} +0 -0
- /package/dist/types/{PersonMentionView.js → PersonPostMentionView.js} +0 -0
- /package/dist/types/{PostAggregates.js → PersonSavedCombinedView.js} +0 -0
- /package/dist/types/{PrivateMessagesResponse.js → ResendVerificationEmail.js} +0 -0
- /package/dist/types/{SiteAggregates.js → SearchCombinedView.js} +0 -0
@@ -0,0 +1,13 @@
|
|
1
|
+
import type { CommentReplyView } from "./CommentReplyView";
|
2
|
+
import type { PersonCommentMentionView } from "./PersonCommentMentionView";
|
3
|
+
import type { PersonPostMentionView } from "./PersonPostMentionView";
|
4
|
+
import type { PrivateMessageView } from "./PrivateMessageView";
|
5
|
+
export type InboxCombinedView = ({
|
6
|
+
type_: "CommentReply";
|
7
|
+
} & CommentReplyView) | ({
|
8
|
+
type_: "CommentMention";
|
9
|
+
} & PersonCommentMentionView) | ({
|
10
|
+
type_: "PostMention";
|
11
|
+
} & PersonPostMentionView) | ({
|
12
|
+
type_: "PrivateMessage";
|
13
|
+
} & PrivateMessageView);
|
@@ -6,6 +6,11 @@ import type { ListingType } from "./ListingType";
|
|
6
6
|
export type ListCommunities = {
|
7
7
|
type_?: ListingType;
|
8
8
|
sort?: CommunitySortType;
|
9
|
+
/**
|
10
|
+
* Filter to within a given time range, in seconds.
|
11
|
+
* IE 60 would give results for the past minute.
|
12
|
+
*/
|
13
|
+
time_range_seconds?: number;
|
9
14
|
show_nsfw?: boolean;
|
10
15
|
page?: number;
|
11
16
|
limit?: number;
|
@@ -0,0 +1,11 @@
|
|
1
|
+
import type { InboxCombinedPaginationCursor } from "./InboxCombinedPaginationCursor";
|
2
|
+
import type { InboxDataType } from "./InboxDataType";
|
3
|
+
/**
|
4
|
+
* Get your inbox (replies, comment mentions, post mentions, and messages)
|
5
|
+
*/
|
6
|
+
export type ListInbox = {
|
7
|
+
type_?: InboxDataType;
|
8
|
+
unread_only?: boolean;
|
9
|
+
page_cursor?: InboxCombinedPaginationCursor;
|
10
|
+
page_back?: boolean;
|
11
|
+
};
|
@@ -1,5 +1,7 @@
|
|
1
1
|
import type { CommunityId } from "./CommunityId";
|
2
|
+
import type { PostId } from "./PostId";
|
2
3
|
import type { ReportCombinedPaginationCursor } from "./ReportCombinedPaginationCursor";
|
4
|
+
import type { ReportType } from "./ReportType";
|
3
5
|
/**
|
4
6
|
* List reports.
|
5
7
|
*/
|
@@ -8,10 +10,26 @@ export type ListReports = {
|
|
8
10
|
* Only shows the unresolved reports
|
9
11
|
*/
|
10
12
|
unresolved_only?: boolean;
|
13
|
+
/**
|
14
|
+
* Filter the type of report.
|
15
|
+
*/
|
16
|
+
type_?: ReportType;
|
17
|
+
/**
|
18
|
+
* Filter by the post id. Can return either comment or post reports.
|
19
|
+
*/
|
20
|
+
post_id?: PostId;
|
11
21
|
/**
|
12
22
|
* if no community is given, it returns reports for all communities moderated by the auth user
|
13
23
|
*/
|
14
24
|
community_id?: CommunityId;
|
15
25
|
page_cursor?: ReportCombinedPaginationCursor;
|
16
26
|
page_back?: boolean;
|
27
|
+
/**
|
28
|
+
* Only for admins: also show reports with `violates_instance_rules=false`
|
29
|
+
*/
|
30
|
+
show_community_rule_violations?: boolean;
|
31
|
+
/**
|
32
|
+
* If true, view all your created reports. Works for non-admins/mods also.
|
33
|
+
*/
|
34
|
+
my_reports_only?: boolean;
|
17
35
|
};
|
@@ -113,4 +113,37 @@ export type LocalSite = {
|
|
113
113
|
* What kind of comment downvotes your site allows.
|
114
114
|
*/
|
115
115
|
comment_downvotes: FederationMode;
|
116
|
+
/**
|
117
|
+
* If this is true, users will never see the dialog asking to support Lemmy development with
|
118
|
+
* donations.
|
119
|
+
*/
|
120
|
+
disable_donation_dialog: boolean;
|
121
|
+
users: number;
|
122
|
+
posts: number;
|
123
|
+
comments: number;
|
124
|
+
communities: number;
|
125
|
+
/**
|
126
|
+
* The number of users with any activity in the last day.
|
127
|
+
*/
|
128
|
+
users_active_day: number;
|
129
|
+
/**
|
130
|
+
* The number of users with any activity in the last week.
|
131
|
+
*/
|
132
|
+
users_active_week: number;
|
133
|
+
/**
|
134
|
+
* The number of users with any activity in the last month.
|
135
|
+
*/
|
136
|
+
users_active_month: number;
|
137
|
+
/**
|
138
|
+
* The number of users with any activity in the last half year.
|
139
|
+
*/
|
140
|
+
users_active_half_year: number;
|
141
|
+
/**
|
142
|
+
* A default time range limit to apply to post sorts, in seconds.
|
143
|
+
*/
|
144
|
+
default_post_time_range_seconds?: number;
|
145
|
+
/**
|
146
|
+
* Block NSFW content being created
|
147
|
+
*/
|
148
|
+
disallow_nsfw_content: boolean;
|
116
149
|
};
|
@@ -84,4 +84,21 @@ export type LocalUser = {
|
|
84
84
|
* Whether to automatically mark fetched posts as read.
|
85
85
|
*/
|
86
86
|
auto_mark_fetched_posts_as_read: boolean;
|
87
|
+
/**
|
88
|
+
* The last time a donation request was shown to this user. If this is more than a year ago,
|
89
|
+
* a new notification request should be shown.
|
90
|
+
*/
|
91
|
+
last_donation_notification: string;
|
92
|
+
/**
|
93
|
+
* Whether to hide posts containing images/videos
|
94
|
+
*/
|
95
|
+
hide_media: boolean;
|
96
|
+
show_score: boolean;
|
97
|
+
show_upvotes: boolean;
|
98
|
+
show_downvotes: boolean;
|
99
|
+
show_upvote_percentage: boolean;
|
100
|
+
/**
|
101
|
+
* A default time range limit to apply to post sorts, in seconds.
|
102
|
+
*/
|
103
|
+
default_post_time_range_seconds?: number;
|
87
104
|
};
|
@@ -1,13 +1,9 @@
|
|
1
1
|
import type { LocalUser } from "./LocalUser";
|
2
|
-
import type { LocalUserVoteDisplayMode } from "./LocalUserVoteDisplayMode";
|
3
2
|
import type { Person } from "./Person";
|
4
|
-
import type { PersonAggregates } from "./PersonAggregates";
|
5
3
|
/**
|
6
4
|
* A local user view.
|
7
5
|
*/
|
8
6
|
export type LocalUserView = {
|
9
7
|
local_user: LocalUser;
|
10
|
-
local_user_vote_display_mode: LocalUserVoteDisplayMode;
|
11
8
|
person: Person;
|
12
|
-
counts: PersonAggregates;
|
13
9
|
};
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { CommunityId } from "./CommunityId";
|
2
|
+
import type { CommunityVisibility } from "./CommunityVisibility";
|
3
|
+
import type { ModChangeCommunityVisibilityId } from "./ModChangeCommunityVisibilityId";
|
4
|
+
import type { PersonId } from "./PersonId";
|
5
|
+
export type ModChangeCommunityVisibility = {
|
6
|
+
id: ModChangeCommunityVisibilityId;
|
7
|
+
community_id: CommunityId;
|
8
|
+
mod_person_id: PersonId;
|
9
|
+
published: string;
|
10
|
+
reason?: string;
|
11
|
+
new_visibility: CommunityVisibility;
|
12
|
+
};
|
@@ -0,0 +1 @@
|
|
1
|
+
export type ModChangeCommunityVisibilityId = number;
|
@@ -0,0 +1,11 @@
|
|
1
|
+
import type { Community } from "./Community";
|
2
|
+
import type { ModChangeCommunityVisibility } from "./ModChangeCommunityVisibility";
|
3
|
+
import type { Person } from "./Person";
|
4
|
+
/**
|
5
|
+
* When the visibility of a community is changed
|
6
|
+
*/
|
7
|
+
export type ModChangeCommunityVisibilityView = {
|
8
|
+
mod_change_community_visibility: ModChangeCommunityVisibility;
|
9
|
+
moderator?: Person;
|
10
|
+
community: Community;
|
11
|
+
};
|
package/dist/types/Person.d.ts
CHANGED
@@ -22,9 +22,9 @@ export type Person = {
|
|
22
22
|
published: string;
|
23
23
|
updated?: string;
|
24
24
|
/**
|
25
|
-
* The federated
|
25
|
+
* The federated ap_id.
|
26
26
|
*/
|
27
|
-
|
27
|
+
ap_id: DbUrl;
|
28
28
|
/**
|
29
29
|
* An optional bio, in markdown.
|
30
30
|
*/
|
@@ -54,4 +54,6 @@ export type Person = {
|
|
54
54
|
*/
|
55
55
|
ban_expires?: string;
|
56
56
|
instance_id: InstanceId;
|
57
|
+
post_count: number;
|
58
|
+
comment_count: number;
|
57
59
|
};
|
@@ -1,11 +1,11 @@
|
|
1
1
|
import type { CommentId } from "./CommentId";
|
2
|
+
import type { PersonCommentMentionId } from "./PersonCommentMentionId";
|
2
3
|
import type { PersonId } from "./PersonId";
|
3
|
-
import type { PersonMentionId } from "./PersonMentionId";
|
4
4
|
/**
|
5
5
|
* A person mention.
|
6
6
|
*/
|
7
|
-
export type
|
8
|
-
id:
|
7
|
+
export type PersonCommentMention = {
|
8
|
+
id: PersonCommentMentionId;
|
9
9
|
recipient_id: PersonId;
|
10
10
|
comment_id: CommentId;
|
11
11
|
read: boolean;
|
@@ -1,27 +1,29 @@
|
|
1
1
|
import type { Comment } from "./Comment";
|
2
|
-
import type { CommentAggregates } from "./CommentAggregates";
|
3
2
|
import type { Community } from "./Community";
|
4
3
|
import type { Person } from "./Person";
|
5
|
-
import type {
|
4
|
+
import type { PersonCommentMention } from "./PersonCommentMention";
|
6
5
|
import type { Post } from "./Post";
|
7
6
|
import type { SubscribedType } from "./SubscribedType";
|
8
7
|
/**
|
9
|
-
* A person mention view.
|
8
|
+
* A person comment mention view.
|
10
9
|
*/
|
11
|
-
export type
|
12
|
-
|
10
|
+
export type PersonCommentMentionView = {
|
11
|
+
person_comment_mention: PersonCommentMention;
|
13
12
|
comment: Comment;
|
14
13
|
creator: Person;
|
15
14
|
post: Post;
|
16
15
|
community: Community;
|
17
16
|
recipient: Person;
|
18
|
-
counts: CommentAggregates;
|
19
17
|
creator_banned_from_community: boolean;
|
20
18
|
banned_from_community: boolean;
|
21
19
|
creator_is_moderator: boolean;
|
22
20
|
creator_is_admin: boolean;
|
23
21
|
subscribed: SubscribedType;
|
24
|
-
|
22
|
+
/**
|
23
|
+
* The time when the comment was saved.
|
24
|
+
*/
|
25
|
+
saved?: string;
|
25
26
|
creator_blocked: boolean;
|
26
27
|
my_vote?: number;
|
28
|
+
can_mod: boolean;
|
27
29
|
};
|
@@ -0,0 +1,13 @@
|
|
1
|
+
import type { PersonId } from "./PersonId";
|
2
|
+
import type { PersonPostMentionId } from "./PersonPostMentionId";
|
3
|
+
import type { PostId } from "./PostId";
|
4
|
+
/**
|
5
|
+
* A person mention.
|
6
|
+
*/
|
7
|
+
export type PersonPostMention = {
|
8
|
+
id: PersonPostMentionId;
|
9
|
+
recipient_id: PersonId;
|
10
|
+
post_id: PostId;
|
11
|
+
read: boolean;
|
12
|
+
published: string;
|
13
|
+
};
|
@@ -0,0 +1,34 @@
|
|
1
|
+
import type { Community } from "./Community";
|
2
|
+
import type { ImageDetails } from "./ImageDetails";
|
3
|
+
import type { Person } from "./Person";
|
4
|
+
import type { PersonPostMention } from "./PersonPostMention";
|
5
|
+
import type { Post } from "./Post";
|
6
|
+
import type { PostTags } from "./PostTags";
|
7
|
+
import type { SubscribedType } from "./SubscribedType";
|
8
|
+
/**
|
9
|
+
* A person post mention view.
|
10
|
+
*/
|
11
|
+
export type PersonPostMentionView = {
|
12
|
+
person_post_mention: PersonPostMention;
|
13
|
+
post: Post;
|
14
|
+
creator: Person;
|
15
|
+
community: Community;
|
16
|
+
image_details?: ImageDetails;
|
17
|
+
recipient: Person;
|
18
|
+
creator_banned_from_community: boolean;
|
19
|
+
banned_from_community: boolean;
|
20
|
+
creator_is_moderator: boolean;
|
21
|
+
creator_is_admin: boolean;
|
22
|
+
subscribed: SubscribedType;
|
23
|
+
/**
|
24
|
+
* The time when the post was saved.
|
25
|
+
*/
|
26
|
+
saved?: string;
|
27
|
+
read: boolean;
|
28
|
+
hidden: boolean;
|
29
|
+
creator_blocked: boolean;
|
30
|
+
my_vote?: number;
|
31
|
+
unread_comments: number;
|
32
|
+
post_tags: PostTags;
|
33
|
+
can_mod: boolean;
|
34
|
+
};
|
package/dist/types/Post.d.ts
CHANGED
@@ -79,4 +79,14 @@ export type Post = {
|
|
79
79
|
* Time at which the post will be published. None means publish immediately.
|
80
80
|
*/
|
81
81
|
scheduled_publish_time?: string;
|
82
|
+
comments: number;
|
83
|
+
score: number;
|
84
|
+
upvotes: number;
|
85
|
+
downvotes: number;
|
86
|
+
/**
|
87
|
+
* The time of the newest comment in the post.
|
88
|
+
*/
|
89
|
+
newest_comment_time: string;
|
90
|
+
report_count: number;
|
91
|
+
unresolved_report_count: number;
|
82
92
|
};
|
@@ -0,0 +1,7 @@
|
|
1
|
+
/**
|
2
|
+
* currently this is just a wrapper around post id, but should be seen as opaque from the client's
|
3
|
+
* perspective. stringified since we might want to use arbitrary info later, with a P prepended to
|
4
|
+
* prevent ossification (api users love to make assumptions (e.g. parse stuff that looks like
|
5
|
+
* numbers as numbers) about apis that aren't part of the spec
|
6
|
+
*/
|
7
|
+
export type PostPaginationCursor = string;
|
@@ -1,7 +1,6 @@
|
|
1
1
|
import type { Community } from "./Community";
|
2
2
|
import type { Person } from "./Person";
|
3
3
|
import type { Post } from "./Post";
|
4
|
-
import type { PostAggregates } from "./PostAggregates";
|
5
4
|
import type { PostReport } from "./PostReport";
|
6
5
|
import type { SubscribedType } from "./SubscribedType";
|
7
6
|
/**
|
@@ -17,12 +16,14 @@ export type PostReportView = {
|
|
17
16
|
creator_is_moderator: boolean;
|
18
17
|
creator_is_admin: boolean;
|
19
18
|
subscribed: SubscribedType;
|
20
|
-
|
19
|
+
/**
|
20
|
+
* The time when the post was saved.
|
21
|
+
*/
|
22
|
+
saved?: string;
|
21
23
|
read: boolean;
|
22
24
|
hidden: boolean;
|
23
25
|
creator_blocked: boolean;
|
24
26
|
my_vote?: number;
|
25
27
|
unread_comments: number;
|
26
|
-
counts: PostAggregates;
|
27
28
|
resolver?: Person;
|
28
29
|
};
|
@@ -1,4 +1,4 @@
|
|
1
1
|
/**
|
2
2
|
* The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
|
3
3
|
*/
|
4
|
-
export type PostSortType = "Active" | "Hot" | "New" | "Old" | "
|
4
|
+
export type PostSortType = "Active" | "Hot" | "New" | "Old" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";
|
package/dist/types/PostView.d.ts
CHANGED
@@ -2,7 +2,6 @@ import type { Community } from "./Community";
|
|
2
2
|
import type { ImageDetails } from "./ImageDetails";
|
3
3
|
import type { Person } from "./Person";
|
4
4
|
import type { Post } from "./Post";
|
5
|
-
import type { PostAggregates } from "./PostAggregates";
|
6
5
|
import type { PostTags } from "./PostTags";
|
7
6
|
import type { SubscribedType } from "./SubscribedType";
|
8
7
|
/**
|
@@ -17,13 +16,16 @@ export type PostView = {
|
|
17
16
|
banned_from_community: boolean;
|
18
17
|
creator_is_moderator: boolean;
|
19
18
|
creator_is_admin: boolean;
|
20
|
-
counts: PostAggregates;
|
21
19
|
subscribed: SubscribedType;
|
22
|
-
|
20
|
+
/**
|
21
|
+
* The time when the post was saved.
|
22
|
+
*/
|
23
|
+
saved?: string;
|
23
24
|
read: boolean;
|
24
25
|
hidden: boolean;
|
25
26
|
creator_blocked: boolean;
|
26
27
|
my_vote?: number;
|
27
28
|
unread_comments: number;
|
28
29
|
tags: PostTags;
|
30
|
+
can_mod: boolean;
|
29
31
|
};
|
@@ -32,6 +32,10 @@ export type SaveUserSettings = {
|
|
32
32
|
* The default post sort, usually "active"
|
33
33
|
*/
|
34
34
|
default_post_sort_type?: PostSortType;
|
35
|
+
/**
|
36
|
+
* A default time range limit to apply to post sorts, in seconds. 0 means none.
|
37
|
+
*/
|
38
|
+
default_post_time_range_seconds?: number;
|
35
39
|
/**
|
36
40
|
* The default comment sort, usually "hot"
|
37
41
|
*/
|
@@ -116,4 +120,8 @@ export type SaveUserSettings = {
|
|
116
120
|
* Whether to automatically mark fetched posts as read.
|
117
121
|
*/
|
118
122
|
auto_mark_fetched_posts_as_read?: boolean;
|
123
|
+
/**
|
124
|
+
* Whether to hide posts containing images/videos.
|
125
|
+
*/
|
126
|
+
hide_media?: boolean;
|
119
127
|
};
|
package/dist/types/Search.d.ts
CHANGED
@@ -1,23 +1,29 @@
|
|
1
1
|
import type { CommunityId } from "./CommunityId";
|
2
2
|
import type { ListingType } from "./ListingType";
|
3
3
|
import type { PersonId } from "./PersonId";
|
4
|
-
import type {
|
4
|
+
import type { SearchCombinedPaginationCursor } from "./SearchCombinedPaginationCursor";
|
5
|
+
import type { SearchSortType } from "./SearchSortType";
|
5
6
|
import type { SearchType } from "./SearchType";
|
6
7
|
/**
|
7
|
-
* Searches the site, given a
|
8
|
+
* Searches the site, given a search term, and some optional filters.
|
8
9
|
*/
|
9
10
|
export type Search = {
|
10
|
-
|
11
|
+
search_term?: string;
|
11
12
|
community_id?: CommunityId;
|
12
13
|
community_name?: string;
|
13
14
|
creator_id?: PersonId;
|
14
15
|
type_?: SearchType;
|
15
|
-
sort?:
|
16
|
+
sort?: SearchSortType;
|
17
|
+
/**
|
18
|
+
* Filter to within a given time range, in seconds.
|
19
|
+
* IE 60 would give results for the past minute.
|
20
|
+
*/
|
21
|
+
time_range_seconds?: number;
|
16
22
|
listing_type?: ListingType;
|
17
|
-
page?: number;
|
18
|
-
limit?: number;
|
19
23
|
title_only?: boolean;
|
20
24
|
post_url_only?: boolean;
|
21
25
|
liked_only?: boolean;
|
22
26
|
disliked_only?: boolean;
|
27
|
+
page_cursor?: SearchCombinedPaginationCursor;
|
28
|
+
page_back?: boolean;
|
23
29
|
};
|
@@ -0,0 +1,13 @@
|
|
1
|
+
import type { CommentView } from "./CommentView";
|
2
|
+
import type { CommunityView } from "./CommunityView";
|
3
|
+
import type { PersonView } from "./PersonView";
|
4
|
+
import type { PostView } from "./PostView";
|
5
|
+
export type SearchCombinedView = ({
|
6
|
+
type_: "Post";
|
7
|
+
} & PostView) | ({
|
8
|
+
type_: "Comment";
|
9
|
+
} & CommentView) | ({
|
10
|
+
type_: "Community";
|
11
|
+
} & CommunityView) | ({
|
12
|
+
type_: "Person";
|
13
|
+
} & PersonView);
|
@@ -1,15 +1,7 @@
|
|
1
|
-
import type {
|
2
|
-
import type { CommunityView } from "./CommunityView";
|
3
|
-
import type { PersonView } from "./PersonView";
|
4
|
-
import type { PostView } from "./PostView";
|
5
|
-
import type { SearchType } from "./SearchType";
|
1
|
+
import type { SearchCombinedView } from "./SearchCombinedView";
|
6
2
|
/**
|
7
3
|
* The search response, containing lists of the return type possibilities
|
8
4
|
*/
|
9
5
|
export type SearchResponse = {
|
10
|
-
|
11
|
-
comments: Array<CommentView>;
|
12
|
-
posts: Array<PostView>;
|
13
|
-
communities: Array<CommunityView>;
|
14
|
-
users: Array<PersonView>;
|
6
|
+
results: Array<SearchCombinedView>;
|
15
7
|
};
|