lemmy-js-client 1.0.0-api-updates-5.0 → 1.0.0-api-updates-6.0

package/dist/http.d.ts

@@ -51,20 +51,14 @@ import { OAuthProvider } from "./types/OAuthProvider";
 import { FeaturePost } from "./types/FeaturePost";
 import { FollowCommunity } from "./types/FollowCommunity";
 import { GetCaptchaResponse } from "./types/GetCaptchaResponse";
-import { GetCommentsResponse } from "./types/GetCommentsResponse";
 import { GetCommunityResponse } from "./types/GetCommunityResponse";
-import { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
-import { GetModlogResponse } from "./types/GetModlogResponse";
 import { GetPersonDetailsResponse } from "./types/GetPersonDetailsResponse";
 import { GetPostResponse } from "./types/GetPostResponse";
-import { GetPostsResponse } from "./types/GetPostsResponse";
 import { GetReportCountResponse } from "./types/GetReportCountResponse";
 import { GetSiteMetadataResponse } from "./types/GetSiteMetadataResponse";
 import { GetSiteResponse } from "./types/GetSiteResponse";
 import { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
 import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
-import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
-import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
 import { LockPost } from "./types/LockPost";
 import { LockComment } from "./types/LockComment";
 import { Login } from "./types/Login";
@@ -101,52 +95,56 @@ import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 import { UpdateTotp } from "./types/UpdateTotp";
 import { UpdateTotpResponse } from "./types/UpdateTotpResponse";
 import { SuccessResponse } from "./types/SuccessResponse";
-import { ListPostLikesResponse } from "./types/ListPostLikesResponse";
-import { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
 import { HidePost } from "./types/HidePost";
-import { ListMediaResponse } from "./types/ListMediaResponse";
 import { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
 import { CreateTagline } from "./types/CreateTagline";
 import { TaglineResponse } from "./types/TaglineResponse";
 import { UpdateTagline } from "./types/UpdateTagline";
 import { DeleteTagline } from "./types/DeleteTagline";
-import { ListTaglinesResponse } from "./types/ListTaglinesResponse";
 import { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
 import { ApproveCommunityPendingFollower } from "./types/ApproveCommunityPendingFollower";
 import { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPendingFollowsCountResponse";
-import { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
-import { ListReportsResponse } from "./types/ListReportsResponse";
 import { MyUserInfo } from "./types/MyUserInfo";
 import { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
 import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
-import { ListPersonContentResponse } from "./types/ListPersonContentResponse";
-import { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
 import { UploadImageResponse } from "./types/UploadImageResponse";
-import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
 import { Tag } from "./types/Tag";
 import { ResendVerificationEmail } from "./types/ResendVerificationEmail";
-import { ListPersonReadResponse } from "./types/ListPersonReadResponse";
-import { ListPersonHiddenResponse } from "./types/ListPersonHiddenResponse";
 import { CommunityIdQuery } from "./types/CommunityIdQuery";
 import { CreateMultiCommunity } from "./types/CreateMultiCommunity";
 import { UpdateMultiCommunity } from "./types/UpdateMultiCommunity";
-import { ListMultiCommunitiesResponse } from "./types/ListMultiCommunitiesResponse";
-import { AdminListUsersResponse } from "./types/AdminListUsersResponse";
 import { CreateOrDeleteMultiCommunityEntry } from "./types/CreateOrDeleteMultiCommunityEntry";
 import { GetMultiCommunityResponse } from "./types/GetMultiCommunityResponse";
 import { FollowMultiCommunity } from "./types/FollowMultiCommunity";
 import { ListLoginsResponse } from "./types/ListLoginsResponse";
-import { ListPersonLikedResponse } from "./types/ListPersonLikedResponse";
 import { NotePerson } from "./types/NotePerson";
 import { UserBlockInstanceCommunitiesParams } from "./types/UserBlockInstanceCommunitiesParams";
 import { UserBlockInstancePersonsParams } from "./types/UserBlockInstancePersonsParams";
 import { MarkNotificationAsRead } from "./types/MarkNotificationAsRead";
-import { ListNotificationsResponse } from "./types/ListNotificationsResponse";
 import { ModEditPost } from "./types/ModEditPost";
 import { UpdateCommunityNotifications } from "./types/UpdateCommunityNotifications";
 import { UpdatePostNotifications } from "./types/UpdatePostNotifications";
 import { MultiCommunityResponse } from "./types/MultiCommunityResponse";
 import { PersonResponse } from "./types/PersonResponse";
+import { LocalImageView } from "./types/LocalImageView";
+import { PagedResponse } from "./types/PagedResponse";
+import { ModlogView } from "./types/ModlogView";
+import { CommunityView } from "./types/CommunityView";
+import { PendingFollowerView } from "./types/PendingFollowerView";
+import { PostView } from "./types/PostView";
+import { VoteView } from "./types/VoteView";
+import { CommentView } from "./types/CommentView";
+import { CommentSlimView } from "./types/CommentSlimView";
+import { PersonContentCombinedView } from "./types/PersonContentCombinedView";
+import { LocalUserView } from "./types/LocalUserView";
+import { PersonSavedCombinedView } from "./types/PersonSavedCombinedView";
+import { NotificationView } from "./types/NotificationView";
+import { PersonLikedCombinedView } from "./types/PersonLikedCombinedView";
+import { RegistrationApplicationView } from "./types/RegistrationApplicationView";
+import { Tagline } from "./types/Tagline";
+import { ReportCombinedView } from "./types/ReportCombinedView";
+import { FederatedInstanceView } from "./types/FederatedInstanceView";
+import { MultiCommunityView } from "./types/MultiCommunityView";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -213,7 +211,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List all the media for your account.
      */
-    listMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
+    listMedia(form?: ListMediaI, options?: RequestOptions): Promise<PagedResponse<LocalImageView>>;
     /**
      * @summary Delete media for your account.
      */
@@ -225,7 +223,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List all the media known to your instance.
      */
-    listMediaAdmin(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
+    listMediaAdmin(form?: ListMediaI, options?: RequestOptions): Promise<PagedResponse<LocalImageView>>;
     /**
      * @summary Enable / Disable TOTP / two-factor authentication.
      *
@@ -237,7 +235,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get the modlog.
      */
-    getModlog(form?: GetModlogI, options?: RequestOptions): Promise<GetModlogResponse>;
+    getModlog(form?: GetModlogI, options?: RequestOptions): Promise<PagedResponse<ModlogView>>;
     /**
      * @summary Search lemmy. If `search_term` is a url it also attempts to fetch it, just like `resolve_object`.
      */
@@ -261,7 +259,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List communities, with various filters.
      */
-    listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<ListCommunitiesResponse>;
+    listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<PagedResponse<CommunityView>>;
     /**
      * @summary Follow / subscribe to a community.
      */
@@ -273,7 +271,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get a community's pending followers.
      */
-    listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<ListCommunityPendingFollowsResponse>;
+    listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<PagedResponse<PendingFollowerView>>;
     /**
      * @summary Approve a community pending follow request.
      */
@@ -365,7 +363,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get / fetch posts, with various filters.
      */
-    getPosts(form?: GetPostsI, options?: RequestOptions): Promise<GetPostsResponse>;
+    getPosts(form?: GetPostsI, options?: RequestOptions): Promise<PagedResponse<PostView>>;
     /**
      * @summary Like / vote on a post.
      */
@@ -373,7 +371,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List a post's likes. Admin-only.
      */
-    listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<ListPostLikesResponse>;
+    listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<PagedResponse<VoteView>>;
     /**
      * @summary Save a post.
      */
@@ -417,7 +415,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List a comment's likes. Admin-only.
      */
-    listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<ListCommentLikesResponse>;
+    listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<PagedResponse<VoteView>>;
     /**
      * @summary Save a comment.
      */
@@ -429,11 +427,11 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get / fetch comments.
      */
-    getComments(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsResponse>;
+    getComments(form?: GetCommentsI, options?: RequestOptions): Promise<PagedResponse<CommentView>>;
     /**
      * @summary Get / fetch comments, but without the post or community.
      */
-    getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsSlimResponse>;
+    getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<PagedResponse<CommentSlimView>>;
     /**
      * @summary Get / fetch comment.
      */
@@ -485,7 +483,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List the content for a person.
      */
-    listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
+    listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<PagedResponse<PersonContentCombinedView>>;
     /**
      * @summary Make a note for a person.
      */
@@ -497,7 +495,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get a list of users.
      */
-    listUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<AdminListUsersResponse>;
+    listUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<PagedResponse<LocalUserView>>;
     /**
      * @summary Block a person.
      */
@@ -545,7 +543,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
      */
-    listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<ListNotificationsResponse>;
+    listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<PagedResponse<NotificationView>>;
     /**
      * @summary Verify your email
      */
@@ -557,19 +555,19 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List your saved content.
      */
-    listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<ListPersonSavedResponse>;
+    listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<PagedResponse<PersonSavedCombinedView>>;
     /**
      * @summary List your read content.
      */
-    listPersonRead(form: ListPersonReadI, options?: RequestOptions): Promise<ListPersonReadResponse>;
+    listPersonRead(form: ListPersonReadI, options?: RequestOptions): Promise<PagedResponse<PendingFollowerView>>;
     /**
      * @summary List your hidden content.
      */
-    listPersonHidden(form: ListPersonHiddenI, options?: RequestOptions): Promise<ListPersonHiddenResponse>;
+    listPersonHidden(form: ListPersonHiddenI, options?: RequestOptions): Promise<PagedResponse<PostView>>;
     /**
      * @summary List your liked content.
      */
-    listPersonLiked(form: ListPersonLikedI, options?: RequestOptions): Promise<ListPersonLikedResponse>;
+    listPersonLiked(form: ListPersonLikedI, options?: RequestOptions): Promise<PagedResponse<PersonLikedCombinedView>>;
     /**
      * @summary Add an admin to your site.
      */
@@ -581,7 +579,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List the registration applications.
      */
-    listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<ListRegistrationApplicationsResponse>;
+    listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<PagedResponse<RegistrationApplicationView>>;
     /**
      * @summary Approve a registration application
      */
@@ -637,7 +635,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List taglines.
      */
-    listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<ListTaglinesResponse>;
+    listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<PagedResponse<Tagline>>;
     /**
      * @summary Create a community post tag.
      */
@@ -669,11 +667,11 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Fetch federated instances.
      */
-    getFederatedInstances(form: GetFederatedInstancesI, options?: RequestOptions): Promise<GetFederatedInstancesResponse>;
+    getFederatedInstances(form: GetFederatedInstancesI, options?: RequestOptions): Promise<PagedResponse<FederatedInstanceView>>;
     /**
      * @summary List user reports.
      */
-    listReports(form: ListReportsI, options?: RequestOptions): Promise<ListReportsResponse>;
+    listReports(form: ListReportsI, options?: RequestOptions): Promise<PagedResponse<ReportCombinedView>>;
     /**
      * @summary Block an instance's communities as a user.
      */
@@ -755,7 +753,7 @@ export declare class LemmyHttp extends Controller {
     getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
     createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<CommunityResponse>;
     deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
-    listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<ListMultiCommunitiesResponse>;
+    listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<PagedResponse<MultiCommunityView>>;
     followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
     /**
      * @summary Change notification settings for a community

package/dist/index.d.ts

@@ -8,7 +8,6 @@ export { AddModToCommunityResponse } from "./types/AddModToCommunityResponse";
 export { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
 export { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
 export { AdminListUsers } from "./types/AdminListUsers";
-export { AdminListUsersResponse } from "./types/AdminListUsersResponse";
 export { AllLemmyErrors } from "./types/AllLemmyErrors";
 export { ApproveCommunityPendingFollower } from "./types/ApproveCommunityPendingFollower";
 export { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
@@ -100,16 +99,12 @@ export { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 export { GetCaptchaResponse } from "./types/GetCaptchaResponse";
 export { GetComment } from "./types/GetComment";
 export { GetComments } from "./types/GetComments";
-export { GetCommentsResponse } from "./types/GetCommentsResponse";
-export { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
 export { GetCommunity } from "./types/GetCommunity";
 export { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPendingFollowsCountResponse";
 export { GetCommunityResponse } from "./types/GetCommunityResponse";
 export { GetFederatedInstances } from "./types/GetFederatedInstances";
 export { GetFederatedInstancesKind } from "./types/GetFederatedInstancesKind";
-export { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
 export { GetModlog } from "./types/GetModlog";
-export { GetModlogResponse } from "./types/GetModlogResponse";
 export { GetMultiCommunity } from "./types/GetMultiCommunity";
 export { GetMultiCommunityResponse } from "./types/GetMultiCommunityResponse";
 export { GetPersonDetails } from "./types/GetPersonDetails";
@@ -117,7 +112,6 @@ export { GetPersonDetailsResponse } from "./types/GetPersonDetailsResponse";
 export { GetPost } from "./types/GetPost";
 export { GetPostResponse } from "./types/GetPostResponse";
 export { GetPosts } from "./types/GetPosts";
-export { GetPostsResponse } from "./types/GetPostsResponse";
 export { GetRandomCommunity } from "./types/GetRandomCommunity";
 export { GetRegistrationApplication } from "./types/GetRegistrationApplication";
 export { GetReportCount } from "./types/GetReportCount";
@@ -142,38 +136,23 @@ export { LemmyErrorType } from "./types/LemmyErrorType";
 export { LikeType } from "./types/LikeType";
 export { LinkMetadata } from "./types/LinkMetadata";
 export { ListCommentLikes } from "./types/ListCommentLikes";
-export { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
 export { ListCommunities } from "./types/ListCommunities";
-export { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
 export { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
-export { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
 export { ListCustomEmojis } from "./types/ListCustomEmojis";
 export { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
 export { ListLoginsResponse } from "./types/ListLoginsResponse";
 export { ListMedia } from "./types/ListMedia";
-export { ListMediaResponse } from "./types/ListMediaResponse";
 export { ListMultiCommunities } from "./types/ListMultiCommunities";
-export { ListMultiCommunitiesResponse } from "./types/ListMultiCommunitiesResponse";
 export { ListNotifications } from "./types/ListNotifications";
-export { ListNotificationsResponse } from "./types/ListNotificationsResponse";
 export { ListPersonContent } from "./types/ListPersonContent";
-export { ListPersonContentResponse } from "./types/ListPersonContentResponse";
 export { ListPersonHidden } from "./types/ListPersonHidden";
-export { ListPersonHiddenResponse } from "./types/ListPersonHiddenResponse";
 export { ListPersonLiked } from "./types/ListPersonLiked";
-export { ListPersonLikedResponse } from "./types/ListPersonLikedResponse";
 export { ListPersonRead } from "./types/ListPersonRead";
-export { ListPersonReadResponse } from "./types/ListPersonReadResponse";
 export { ListPersonSaved } from "./types/ListPersonSaved";
-export { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
 export { ListPostLikes } from "./types/ListPostLikes";
-export { ListPostLikesResponse } from "./types/ListPostLikesResponse";
 export { ListRegistrationApplications } from "./types/ListRegistrationApplications";
-export { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
 export { ListReports } from "./types/ListReports";
-export { ListReportsResponse } from "./types/ListReportsResponse";
 export { ListTaglines } from "./types/ListTaglines";
-export { ListTaglinesResponse } from "./types/ListTaglinesResponse";
 export { ListingType } from "./types/ListingType";
 export { LocalImage } from "./types/LocalImage";
 export { LocalImageView } from "./types/LocalImageView";
@@ -217,6 +196,7 @@ export { OAuthAccount } from "./types/OAuthAccount";
 export { OAuthProvider } from "./types/OAuthProvider";
 export { OAuthProviderId } from "./types/OAuthProviderId";
 export { OpenGraphData } from "./types/OpenGraphData";
+export { PagedResponse } from "./types/PagedResponse";
 export { PaginationCursor } from "./types/PaginationCursor";
 export { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
 export { PasswordReset } from "./types/PasswordReset";

package/dist/types/AdminListUsers.d.ts

@@ -2,6 +2,5 @@ import type { PaginationCursor } from "./PaginationCursor";
 export type AdminListUsers = {
     banned_only?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/GetComments.d.ts

@@ -17,7 +17,6 @@ export type GetComments = {
     time_range_seconds?: number;
     max_depth?: number;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
     community_id?: CommunityId;
     community_name?: string;

package/dist/types/GetFederatedInstances.d.ts

@@ -4,6 +4,5 @@ export type GetFederatedInstances = {
     domain_filter?: string;
     kind: GetFederatedInstancesKind;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/GetModlog.d.ts

@@ -39,6 +39,5 @@ export type GetModlog = {
      */
     comment_id?: CommentId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/GetPosts.d.ts

@@ -41,6 +41,5 @@ export type GetPosts = {
      */
     no_comments_only?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommentLikes.d.ts

@@ -6,6 +6,5 @@ import type { PaginationCursor } from "./PaginationCursor";
 export type ListCommentLikes = {
     comment_id: CommentId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommunities.d.ts

@@ -14,6 +14,5 @@ export type ListCommunities = {
     time_range_seconds?: number;
     show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommunityPendingFollows.d.ts

@@ -6,6 +6,5 @@ export type ListCommunityPendingFollows = {
     unread_only?: boolean;
     all_communities?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListMedia.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListMedia = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListMultiCommunities.d.ts

@@ -12,6 +12,5 @@ export type ListMultiCommunities = {
      */
     time_range_seconds?: number;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListNotifications.d.ts

@@ -7,6 +7,5 @@ export type ListNotifications = {
     type_?: NotificationDataType;
     unread_only?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonContent.d.ts

@@ -14,6 +14,5 @@ export type ListPersonContent = {
      */
     username?: string;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonHidden.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListPersonHidden = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonLiked.d.ts

@@ -8,6 +8,5 @@ export type ListPersonLiked = {
     type_?: PersonContentType;
     like_type?: LikeType;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonRead.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListPersonRead = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonSaved.d.ts

@@ -6,6 +6,5 @@ import type { PersonContentType } from "./PersonContentType";
 export type ListPersonSaved = {
     type_?: PersonContentType;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPostLikes.d.ts

@@ -6,6 +6,5 @@ import type { PostId } from "./PostId";
 export type ListPostLikes = {
     post_id: PostId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListRegistrationApplications.d.ts

@@ -8,6 +8,5 @@ export type ListRegistrationApplications = {
      */
     unread_only?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListReports.d.ts

@@ -23,7 +23,6 @@ export type ListReports = {
      */
     community_id?: CommunityId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
     /**
      * Only for admins: also show reports with `violates_instance_rules=false`

package/dist/types/ListTaglines.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListTaglines = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/PagedResponse.d.ts

@@ -0,0 +1,11 @@
+import type { PaginationCursor } from "./PaginationCursor";
+/**
+ * This response contains only a single page of items. To get the next page, take the
+ * cursor string from `next_page` and pass it to the same API endpoint via `page_cursor`
+ * parameter. For going to the previous page, use `prev_page` instead.
+ */
+export type PagedResponse<T> = {
+    data: Array<T>;
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
+};

package/dist/types/PaginationCursor.d.ts

@@ -1,4 +1,8 @@
 /**
- * A pagination cursor
+ * To get the next or previous page, pass this string unchanged as `page_cursor` in a new request
+ * to the same endpoint.
+ *
+ * Do not attempt to parse or modify the cursor string. The format is internal and may change in
+ * minor Lemmy versions.
  */
 export type PaginationCursor = string;

package/dist/types/PluginMetadata.d.ts

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

package/dist/types/Search.d.ts

@@ -8,6 +8,10 @@ import type { SearchType } from "./SearchType";
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
+    /**
+     * 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;
@@ -29,6 +33,5 @@ export type Search = {
      */
     show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/SearchResponse.d.ts

@@ -4,7 +4,17 @@ 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.
+     * This is always empty when calling `/api/v4/resolve_object`
+     */
+    search: Array<SearchCombinedView>;
     /**
      * the pagination cursor to use to fetch the next page
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-api-updates-5.0",
+  "version": "1.0.0-api-updates-6.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -44,7 +44,7 @@
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.20.0",
+  "packageManager": "pnpm@10.24.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/AdminListUsersResponse.d.ts

@@ -1,10 +0,0 @@
-import type { LocalUserView } from "./LocalUserView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type AdminListUsersResponse = {
-    users: Array<LocalUserView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetCommentsResponse.d.ts

@@ -1,10 +0,0 @@
-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/GetCommentsResponse.js

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

package/dist/types/GetCommentsSlimResponse.d.ts

@@ -1,10 +0,0 @@
-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/GetCommentsSlimResponse.js

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

package/dist/types/GetFederatedInstancesResponse.d.ts

@@ -1,10 +0,0 @@
-import type { FederatedInstanceView } from "./FederatedInstanceView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * A response of federated instances.
- */
-export type GetFederatedInstancesResponse = {
-    federated_instances: Array<FederatedInstanceView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetFederatedInstancesResponse.js

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

package/dist/types/GetModlogResponse.d.ts

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

package/dist/types/GetModlogResponse.js

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

package/dist/types/GetPostsResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PostView } from "./PostView";
-/**
- * The post list response.
- */
-export type GetPostsResponse = {
-    posts: Array<PostView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetPostsResponse.js

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

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { VoteView } from "./VoteView";
-/**
- * The comment likes response
- */
-export type ListCommentLikesResponse = {
-    comment_likes: Array<VoteView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommentLikesResponse.js

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

package/dist/types/ListCommunitiesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { CommunityView } from "./CommunityView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * The response for listing communities.
- */
-export type ListCommunitiesResponse = {
-    communities: Array<CommunityView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommunitiesResponse.js

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

package/dist/types/ListCommunityPendingFollowsResponse.d.ts

@@ -1,10 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PendingFollowerView } from "./PendingFollowerView";
-export type ListCommunityPendingFollowsResponse = {
-    items: Array<PendingFollowerView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListCommunityPendingFollowsResponse.js

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

package/dist/types/ListMediaResponse.d.ts

@@ -1,10 +0,0 @@
-import type { LocalImageView } from "./LocalImageView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type ListMediaResponse = {
-    images: Array<LocalImageView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListMediaResponse.js

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

package/dist/types/ListMultiCommunitiesResponse.d.ts

@@ -1,10 +0,0 @@
-import type { MultiCommunityView } from "./MultiCommunityView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type ListMultiCommunitiesResponse = {
-    multi_communities: Array<MultiCommunityView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListMultiCommunitiesResponse.js

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

package/dist/types/ListNotificationsResponse.d.ts

@@ -1,13 +0,0 @@
-import type { NotificationView } from "./NotificationView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * Get your inbox (replies, comment mentions, post mentions, and messages)
- */
-export type ListNotificationsResponse = {
-    notifications: Array<NotificationView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListNotificationsResponse.js

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

package/dist/types/ListPersonContentResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PersonContentCombinedView } from "./PersonContentCombinedView";
-/**
- * A person's content response.
- */
-export type ListPersonContentResponse = {
-    content: Array<PersonContentCombinedView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonContentResponse.js

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

package/dist/types/ListPersonHiddenResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PostView } from "./PostView";
-/**
- * You hidden posts response.
- */
-export type ListPersonHiddenResponse = {
-    hidden: Array<PostView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonHiddenResponse.js

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

package/dist/types/ListPersonLikedResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PersonLikedCombinedView } from "./PersonLikedCombinedView";
-/**
- * Your liked posts response.
- */
-export type ListPersonLikedResponse = {
-    liked: Array<PersonLikedCombinedView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonLikedResponse.js

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

package/dist/types/ListPersonReadResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PostView } from "./PostView";
-/**
- * You read posts response.
- */
-export type ListPersonReadResponse = {
-    read: Array<PostView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonReadResponse.js

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

package/dist/types/ListPersonSavedResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { PersonSavedCombinedView } from "./PersonSavedCombinedView";
-/**
- * A person's saved content response.
- */
-export type ListPersonSavedResponse = {
-    saved: Array<PersonSavedCombinedView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPersonSavedResponse.js

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

package/dist/types/ListPostLikesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { VoteView } from "./VoteView";
-/**
- * The post likes response
- */
-export type ListPostLikesResponse = {
-    post_likes: Array<VoteView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListPostLikesResponse.js

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

package/dist/types/ListRegistrationApplicationsResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { RegistrationApplicationView } from "./RegistrationApplicationView";
-/**
- * The list of registration applications.
- */
-export type ListRegistrationApplicationsResponse = {
-    registration_applications: Array<RegistrationApplicationView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListRegistrationApplicationsResponse.js

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

package/dist/types/ListReportsResponse.d.ts

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

package/dist/types/ListReportsResponse.js

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

package/dist/types/ListTaglinesResponse.d.ts

@@ -1,13 +0,0 @@
-import type { PaginationCursor } from "./PaginationCursor";
-import type { Tagline } from "./Tagline";
-/**
- * A response for taglines.
- */
-export type ListTaglinesResponse = {
-    taglines: Array<Tagline>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/ListTaglinesResponse.js

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