lemmy-js-client 0.20.0-alpha.6 → 0.20.0-ap-id.0

package/dist/types/LoginResponse.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/LoginToken.d.ts

@@ -1,7 +1,17 @@
 import type { LocalUserId } from "./LocalUserId";
-export interface LoginToken {
+/**
+ * Stores data related to a specific user login session.
+ */
+export type LoginToken = {
     user_id: LocalUserId;
+    /**
+     * Time of login
+     */
     published: string;
+    /**
+     * IP address where login was made from, allows invalidating logins by IP address.
+     * Could be stored in truncated format, or store derived information for better privacy.
+     */
     ip?: string;
     user_agent?: string;
-}
+};

package/dist/types/MarkCommentReplyAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { CommentReplyId } from "./CommentReplyId";
-export interface MarkCommentReplyAsRead {
+/**
+ * Mark a comment reply as read.
+ */
+export type MarkCommentReplyAsRead = {
     comment_reply_id: CommentReplyId;
     read: boolean;
-}
+};

package/dist/types/MarkManyPostsAsRead.d.ts

@@ -0,0 +1,7 @@
+import type { PostId } from "./PostId";
+/**
+ * Mark several posts as read.
+ */
+export type MarkManyPostsAsRead = {
+    post_ids: Array<PostId>;
+};

package/dist/types/MarkManyPostsAsRead.js

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

package/dist/types/MarkPersonCommentMentionAsRead.d.ts

@@ -0,0 +1,8 @@
+import type { PersonCommentMentionId } from "./PersonCommentMentionId";
+/**
+ * Mark a person mention as read.
+ */
+export type MarkPersonCommentMentionAsRead = {
+    person_comment_mention_id: PersonCommentMentionId;
+    read: boolean;
+};

package/dist/types/MarkPersonCommentMentionAsRead.js

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

package/dist/types/MarkPersonPostMentionAsRead.d.ts

@@ -0,0 +1,8 @@
+import type { PersonPostMentionId } from "./PersonPostMentionId";
+/**
+ * Mark a person mention as read.
+ */
+export type MarkPersonPostMentionAsRead = {
+    person_post_mention_id: PersonPostMentionId;
+    read: boolean;
+};

package/dist/types/MarkPersonPostMentionAsRead.js

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

package/dist/types/MarkPostAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface MarkPostAsRead {
-    post_ids: Array<PostId>;
+/**
+ * Mark a post as read.
+ */
+export type MarkPostAsRead = {
+    post_id: PostId;
     read: boolean;
-}
+};

package/dist/types/MarkPrivateMessageAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface MarkPrivateMessageAsRead {
+/**
+ * Mark a private message as read.
+ */
+export type MarkPrivateMessageAsRead = {
     private_message_id: PrivateMessageId;
     read: boolean;
-}
+};

package/dist/types/ModAdd.d.ts

@@ -1,8 +1,12 @@
+import type { ModAddId } from "./ModAddId";
 import type { PersonId } from "./PersonId";
-export interface ModAdd {
-    id: number;
+/**
+ * When someone is added as a site moderator.
+ */
+export type ModAdd = {
+    id: ModAddId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     removed: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModAddCommunity.d.ts

@@ -1,10 +1,14 @@
 import type { CommunityId } from "./CommunityId";
+import type { ModAddCommunityId } from "./ModAddCommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModAddCommunity {
-    id: number;
+/**
+ * When someone is added as a community moderator.
+ */
+export type ModAddCommunity = {
+    id: ModAddCommunityId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     removed: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModAddCommunityId.d.ts

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

package/dist/types/ModAddCommunityId.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/ModAddCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModAddCommunity } from "./ModAddCommunity";
 import type { Person } from "./Person";
-export interface ModAddCommunityView {
+/**
+ * When someone is added as a community moderator.
+ */
+export type ModAddCommunityView = {
     mod_add_community: ModAddCommunity;
     moderator?: Person;
     community: Community;
-    modded_person: Person;
-}
+    other_person: Person;
+};

package/dist/types/ModAddId.d.ts

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

package/dist/types/ModAddId.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/ModAddView.d.ts

@@ -1,7 +1,10 @@
 import type { ModAdd } from "./ModAdd";
 import type { Person } from "./Person";
-export interface ModAddView {
+/**
+ * When someone is added as a site moderator.
+ */
+export type ModAddView = {
     mod_add: ModAdd;
     moderator?: Person;
-    modded_person: Person;
-}
+    other_person: Person;
+};

package/dist/types/ModBan.d.ts

@@ -1,10 +1,14 @@
+import type { ModBanId } from "./ModBanId";
 import type { PersonId } from "./PersonId";
-export interface ModBan {
-    id: number;
+/**
+ * When someone is banned from the site.
+ */
+export type ModBan = {
+    id: ModBanId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     reason?: string;
     banned: boolean;
     expires?: string;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModBanFromCommunity.d.ts

@@ -1,12 +1,16 @@
 import type { CommunityId } from "./CommunityId";
+import type { ModBanFromCommunityId } from "./ModBanFromCommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModBanFromCommunity {
-    id: number;
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunity = {
+    id: ModBanFromCommunityId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
     banned: boolean;
     expires?: string;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModBanFromCommunityId.d.ts

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

package/dist/types/ModBanFromCommunityId.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/ModBanFromCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModBanFromCommunity } from "./ModBanFromCommunity";
 import type { Person } from "./Person";
-export interface ModBanFromCommunityView {
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunityView = {
     mod_ban_from_community: ModBanFromCommunity;
     moderator?: Person;
     community: Community;
-    banned_person: Person;
-}
+    other_person: Person;
+};

package/dist/types/ModBanId.d.ts

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

package/dist/types/ModBanId.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/ModBanView.d.ts

@@ -1,7 +1,10 @@
 import type { ModBan } from "./ModBan";
 import type { Person } from "./Person";
-export interface ModBanView {
+/**
+ * When someone is banned from the site.
+ */
+export type ModBanView = {
     mod_ban: ModBan;
     moderator?: Person;
-    banned_person: Person;
-}
+    other_person: Person;
+};

package/dist/types/ModFeaturePost.d.ts

@@ -1,10 +1,14 @@
+import type { ModFeaturePostId } from "./ModFeaturePostId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModFeaturePost {
-    id: number;
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePost = {
+    id: ModFeaturePostId;
     mod_person_id: PersonId;
     post_id: PostId;
     featured: boolean;
-    when_: string;
+    published: string;
     is_featured_community: boolean;
-}
+};

package/dist/types/ModFeaturePostId.d.ts

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

package/dist/types/ModFeaturePostId.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/ModFeaturePostView.d.ts

@@ -2,9 +2,13 @@ import type { Community } from "./Community";
 import type { ModFeaturePost } from "./ModFeaturePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModFeaturePostView {
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePostView = {
     mod_feature_post: ModFeaturePost;
     moderator?: Person;
+    other_person: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModHideCommunity.d.ts

@@ -1,10 +1,14 @@
 import type { CommunityId } from "./CommunityId";
+import type { ModHideCommunityId } from "./ModHideCommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModHideCommunity {
-    id: number;
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunity = {
+    id: ModHideCommunityId;
     community_id: CommunityId;
     mod_person_id: PersonId;
-    when_: string;
+    published: string;
     reason?: string;
     hidden: boolean;
-}
+};

package/dist/types/ModHideCommunityId.d.ts

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

package/dist/types/ModHideCommunityId.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/ModHideCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModHideCommunity } from "./ModHideCommunity";
 import type { Person } from "./Person";
-export interface ModHideCommunityView {
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunityView = {
     mod_hide_community: ModHideCommunity;
     admin?: Person;
     community: Community;
-}
+};

package/dist/types/ModLockPost.d.ts

@@ -1,9 +1,13 @@
+import type { ModLockPostId } from "./ModLockPostId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModLockPost {
-    id: number;
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPost = {
+    id: ModLockPostId;
     mod_person_id: PersonId;
     post_id: PostId;
     locked: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModLockPostId.d.ts

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

package/dist/types/ModLockPostId.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/ModLockPostView.d.ts

@@ -2,9 +2,13 @@ import type { Community } from "./Community";
 import type { ModLockPost } from "./ModLockPost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModLockPostView {
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPostView = {
     mod_lock_post: ModLockPost;
     moderator?: Person;
+    other_person: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveComment.d.ts

@@ -1,10 +1,14 @@
 import type { CommentId } from "./CommentId";
+import type { ModRemoveCommentId } from "./ModRemoveCommentId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveComment {
-    id: number;
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveComment = {
+    id: ModRemoveCommentId;
     mod_person_id: PersonId;
     comment_id: CommentId;
     reason?: string;
     removed: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModRemoveCommentId.d.ts

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

package/dist/types/ModRemoveCommentId.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/ModRemoveCommentView.d.ts

@@ -3,11 +3,14 @@ import type { Community } from "./Community";
 import type { ModRemoveComment } from "./ModRemoveComment";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemoveCommentView {
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveCommentView = {
     mod_remove_comment: ModRemoveComment;
     moderator?: Person;
+    other_person: Person;
     comment: Comment;
-    commenter: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveCommunity.d.ts

@@ -1,10 +1,14 @@
 import type { CommunityId } from "./CommunityId";
+import type { ModRemoveCommunityId } from "./ModRemoveCommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveCommunity {
-    id: number;
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunity = {
+    id: ModRemoveCommunityId;
     mod_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
     removed: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModRemoveCommunityId.d.ts

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

package/dist/types/ModRemoveCommunityId.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/ModRemoveCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModRemoveCommunity } from "./ModRemoveCommunity";
 import type { Person } from "./Person";
-export interface ModRemoveCommunityView {
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunityView = {
     mod_remove_community: ModRemoveCommunity;
     moderator?: Person;
     community: Community;
-}
+};

package/dist/types/ModRemovePost.d.ts

@@ -1,10 +1,14 @@
+import type { ModRemovePostId } from "./ModRemovePostId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModRemovePost {
-    id: number;
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePost = {
+    id: ModRemovePostId;
     mod_person_id: PersonId;
     post_id: PostId;
     reason?: string;
     removed: boolean;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModRemovePostId.d.ts

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

package/dist/types/ModRemovePostId.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/ModRemovePostView.d.ts

@@ -2,9 +2,13 @@ import type { Community } from "./Community";
 import type { ModRemovePost } from "./ModRemovePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemovePostView {
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePostView = {
     mod_remove_post: ModRemovePost;
     moderator?: Person;
+    other_person: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModTransferCommunity.d.ts

@@ -1,9 +1,13 @@
 import type { CommunityId } from "./CommunityId";
+import type { ModTransferCommunityId } from "./ModTransferCommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModTransferCommunity {
-    id: number;
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunity = {
+    id: ModTransferCommunityId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
-    when_: string;
-}
+    published: string;
+};

package/dist/types/ModTransferCommunityId.d.ts

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

package/dist/types/ModTransferCommunityId.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/ModTransferCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModTransferCommunity } from "./ModTransferCommunity";
 import type { Person } from "./Person";
-export interface ModTransferCommunityView {
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunityView = {
     mod_transfer_community: ModTransferCommunity;
     moderator?: Person;
     community: Community;
-    modded_person: Person;
-}
+    other_person: Person;
+};

package/dist/types/ModlogActionType.d.ts

@@ -1 +1,4 @@
-export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment";
+/**
+ * A list of possible types for the various modlog actions.
+ */
+export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";

package/dist/types/ModlogCombinedPaginationCursor.d.ts

@@ -0,0 +1,4 @@
+/**
+ * like PaginationCursor but for the modlog_combined
+ */
+export type ModlogCombinedPaginationCursor = string;

package/dist/types/ModlogCombinedPaginationCursor.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 });