lemmy-js-client 1.0.0-post-notifications.0 → 1.0.0-post-notifications.2

package/dist/http.d.ts

@@ -1,5 +1,5 @@
 import { Controller } from "@tsoa/runtime";
-import { AdminListUsersI, CommunityIdQueryI, DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetMultiCommunityI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListMultiCommunitiesI, ListPersonContentI, ListPersonHiddenI, ListPersonLikedI, ListPersonReadI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
+import { AdminListUsersI, CommunityIdQueryI, DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetMultiCommunityI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListNotificationsI, ListMediaI, ListMultiCommunitiesI, ListPersonContentI, ListPersonHiddenI, ListPersonLikedI, ListPersonReadI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
 import { AddAdmin } from "./types/AddAdmin";
 import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
@@ -127,7 +127,6 @@ import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
 import { ListPersonContentResponse } from "./types/ListPersonContentResponse";
 import { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
 import { UploadImageResponse } from "./types/UploadImageResponse";
-import { ListInboxResponse } from "./types/ListInboxResponse";
 import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
 import { Tag } from "./types/Tag";
 import { ResendVerificationEmail } from "./types/ResendVerificationEmail";
@@ -144,6 +143,7 @@ import { FollowMultiCommunity } from "./types/FollowMultiCommunity";
 import { ListLoginsResponse } from "./types/ListLoginsResponse";
 import { ListPersonLikedResponse } from "./types/ListPersonLikedResponse";
 import { MarkNotificationAsRead } from "./types/MarkNotificationAsRead";
+import { ListNotificationsResponse } from "./types/ListNotificationsResponse";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -534,7 +534,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
      */
-    listInbox(form: ListInboxI, options?: RequestOptions): Promise<ListInboxResponse>;
+    listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<ListNotificationsResponse>;
     /**
      * @summary Verify your email
      */

package/dist/http.js

@@ -607,7 +607,7 @@ let LemmyHttp = class LemmyHttp extends runtime_1.Controller {
     /**
      * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
      */
-    async listInbox(form, options) {
+    async listNotifications(form, options) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/account/inbox", form, options);
     }
     /**
@@ -1632,7 +1632,7 @@ __decorate([
     (0, runtime_1.Tags)("Account"),
     __param(0, (0, runtime_1.Queries)()),
     __param(1, (0, runtime_1.Inject)())
-], LemmyHttp.prototype, "listInbox", null);
+], LemmyHttp.prototype, "listNotifications", null);
 __decorate([
     (0, runtime_1.Post)("/account/auth/verify_email"),
     (0, runtime_1.Tags)("Account"),

package/dist/index.d.ts

@@ -60,6 +60,7 @@ export { CommunityFollowerView } from "./types/CommunityFollowerView";
 export { CommunityId } from "./types/CommunityId";
 export { CommunityIdQuery } from "./types/CommunityIdQuery";
 export { CommunityModeratorView } from "./types/CommunityModeratorView";
+export { CommunityNotificationsMode } from "./types/CommunityNotificationsMode";
 export { CommunityReport } from "./types/CommunityReport";
 export { CommunityReportId } from "./types/CommunityReportId";
 export { CommunityReportResponse } from "./types/CommunityReportResponse";
@@ -170,13 +171,13 @@ export { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows
 export { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
 export { ListCustomEmojis } from "./types/ListCustomEmojis";
 export { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
-export { ListInbox } from "./types/ListInbox";
-export { ListInboxResponse } from "./types/ListInboxResponse";
 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";
@@ -255,6 +256,8 @@ export { MultiCommunityView } from "./types/MultiCommunityView";
 export { MyUserInfo } from "./types/MyUserInfo";
 export { NotePerson } from "./types/NotePerson";
 export { Notification } from "./types/Notification";
+export { NotificationData } from "./types/NotificationData";
+export { NotificationDataType } from "./types/NotificationDataType";
 export { NotificationId } from "./types/NotificationId";
 export { NotificationTypes } from "./types/NotificationTypes";
 export { NotificationView } from "./types/NotificationView";
@@ -286,6 +289,7 @@ export { PostActions } from "./types/PostActions";
 export { PostFeatureType } from "./types/PostFeatureType";
 export { PostId } from "./types/PostId";
 export { PostListingMode } from "./types/PostListingMode";
+export { PostNotificationsMode } from "./types/PostNotificationsMode";
 export { PostOrCommentOrPrivateMessage } from "./types/PostOrCommentOrPrivateMessage";
 export { PostReport } from "./types/PostReport";
 export { PostReportId } from "./types/PostReportId";

package/dist/other_types.d.ts

@@ -18,7 +18,7 @@ import { ListCommentLikes } from "./types/ListCommentLikes";
 import { ListCommunities } from "./types/ListCommunities";
 import { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
 import { ListCustomEmojis } from "./types/ListCustomEmojis";
-import { ListInbox } from "./types/ListInbox";
+import { ListNotifications } from "./types/ListNotifications";
 import { ListMedia } from "./types/ListMedia";
 import { ListMultiCommunities } from "./types/ListMultiCommunities";
 import { ListPersonContent } from "./types/ListPersonContent";
@@ -74,7 +74,7 @@ export interface ListPersonContentI extends ListPersonContent {
 }
 export interface GetReportCountI extends GetReportCount {
 }
-export interface ListInboxI extends ListInbox {
+export interface ListNotificationsI extends ListNotifications {
 }
 export interface ListPersonSavedI extends ListPersonSaved {
 }

package/dist/types/CommunityActions.d.ts

@@ -1,4 +1,5 @@
 import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
 export type CommunityActions = {
     /**
      * When the community was followed.
@@ -24,4 +25,5 @@ export type CommunityActions = {
      * When their ban expires.
      */
     ban_expires_at?: string;
+    notifications?: CommunityNotificationsMode;
 };

package/dist/types/CommunityNotificationsMode.d.ts

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

package/dist/types/CommunityNotificationsMode.js

@@ -0,0 +1,3 @@
+"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/ExportDataResponse.d.ts

@@ -4,7 +4,7 @@ import type { UserSettingsBackup } from "./UserSettingsBackup";
  * Your exported data.
  */
 export type ExportDataResponse = {
-    inbox: Array<PostOrCommentOrPrivateMessage>;
+    notifications: Array<PostOrCommentOrPrivateMessage>;
     content: Array<PostOrCommentOrPrivateMessage>;
     read_posts: Array<string>;
     liked: Array<string>;

package/dist/types/{ListInbox.d.ts → ListNotifications.d.ts}

@@ -1,10 +1,10 @@
-import type { InboxDataType } from "./InboxDataType";
+import type { NotificationDataType } from "./NotificationDataType";
 import type { PaginationCursor } from "./PaginationCursor";
 /**
  * Get your inbox (replies, comment mentions, post mentions, and messages)
  */
-export type ListInbox = {
-    type_?: InboxDataType;
+export type ListNotifications = {
+    type_?: NotificationDataType;
     unread_only?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;

package/dist/types/{ListInboxResponse.d.ts → ListNotificationsResponse.d.ts}

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

package/dist/types/Notification.d.ts

@@ -1,14 +1,16 @@
 import type { CommentId } from "./CommentId";
 import type { NotificationId } from "./NotificationId";
+import type { NotificationTypes } from "./NotificationTypes";
+import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 import type { PrivateMessageId } from "./PrivateMessageId";
-/**
- * A person mention.
- */
 export type Notification = {
     id: NotificationId;
-    post_id?: PostId;
+    recipient_id: PersonId;
     comment_id?: CommentId;
-    private_message_id?: PrivateMessageId;
+    read: boolean;
     published_at: string;
+    kind: NotificationTypes;
+    post_id?: PostId;
+    private_message_id?: PrivateMessageId;
 };

package/dist/types/NotificationData.d.ts

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

package/dist/types/NotificationData.js

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

package/dist/types/NotificationDataType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for the inbox.
+ */
+export type NotificationDataType = "All" | "Reply" | "Mention" | "PrivateMessage" | "Subscribed";

package/dist/types/NotificationDataType.js

@@ -0,0 +1,3 @@
+"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/NotificationTypes.d.ts

@@ -1,4 +1,4 @@
 /**
- * Lets you show votes for others only, show all votes, or hide all votes.
+ * Types of notifications which can be received in inbox
  */
 export type NotificationTypes = "Mention" | "Reply" | "Subscribed" | "PrivateMessage";

package/dist/types/NotificationView.d.ts

@@ -1,36 +1,10 @@
-import type { Comment } from "./Comment";
-import type { CommentActions } from "./CommentActions";
-import type { Community } from "./Community";
-import type { CommunityActions } from "./CommunityActions";
-import type { ImageDetails } from "./ImageDetails";
-import type { InstanceActions } from "./InstanceActions";
-import type { Notification } from "./Notification";
-import type { Person } from "./Person";
-import type { PersonActions } from "./PersonActions";
-import type { PersonNotification } from "./PersonNotification";
-import type { Post } from "./Post";
-import type { PostActions } from "./PostActions";
-import type { PrivateMessage } from "./PrivateMessage";
-import type { TagsView } from "./TagsView";
+import type { NotificationData } from "./NotificationData";
+import type { NotificationId } from "./NotificationId";
+import type { NotificationTypes } from "./NotificationTypes";
+import type { PersonId } from "./PersonId";
 export type NotificationView = {
-    notification: Notification;
-    person_notification: PersonNotification;
-    private_message?: PrivateMessage;
-    comment?: Comment;
-    post?: Post;
-    community?: Community;
-    creator: Person;
-    recipient: Person;
-    image_details?: ImageDetails;
-    community_actions?: CommunityActions;
-    instance_actions?: InstanceActions;
-    post_actions?: PostActions;
-    person_actions?: PersonActions;
-    comment_actions?: CommentActions;
-    item_creator_is_admin: boolean;
-    post_tags: TagsView;
-    can_mod: boolean;
-    creator_banned: boolean;
-    creator_is_moderator: boolean;
-    creator_banned_from_community: boolean;
+    id: NotificationId;
+    kind: NotificationTypes;
+    recipient_id: PersonId;
+    data: NotificationData;
 };

package/dist/types/PostActions.d.ts

@@ -1,4 +1,4 @@
-import type { NotificationsMode } from "./NotificationsMode";
+import type { PostNotificationsMode } from "./PostNotificationsMode";
 export type PostActions = {
     /**
      * When the post was read.
@@ -29,5 +29,5 @@ export type PostActions = {
      * When the post was hidden.
      */
     hidden_at?: string;
-    notifications?: NotificationsMode;
+    notifications?: PostNotificationsMode;
 };

package/dist/types/PostNotificationsMode.d.ts

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

package/dist/types/PostNotificationsMode.js

@@ -0,0 +1,3 @@
+"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/UpdateCommunityNotifications.d.ts

@@ -1,9 +1,9 @@
 import type { CommunityId } from "./CommunityId";
-import type { NotificationsMode } from "./NotificationsMode";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
 /**
- * Disable reply notifications for a post and all comments inside it
+ * Change notification settings for a community
  */
 export type UpdateCommunityNotifications = {
     community_id: CommunityId;
-    new_state: NotificationsMode;
+    mode: CommunityNotificationsMode;
 };

package/dist/types/UpdatePostNotifications.d.ts

@@ -1,9 +1,9 @@
-import type { NotificationsMode } from "./NotificationsMode";
 import type { PostId } from "./PostId";
+import type { PostNotificationsMode } from "./PostNotificationsMode";
 /**
- * Disable reply notifications for a post and all comments inside it
+ * Change notification settings for a post
  */
 export type UpdatePostNotifications = {
     post_id: PostId;
-    new_state: NotificationsMode;
+    mode: PostNotificationsMode;
 };

package/dist/types/VoteView.d.ts

@@ -4,6 +4,7 @@ import type { Person } from "./Person";
  */
 export type VoteView = {
     creator: Person;
+    creator_banned: boolean;
     creator_banned_from_community: boolean;
     score: number;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-post-notifications.0",
+  "version": "1.0.0-post-notifications.2",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",