lemmy-js-client 1.0.0-dont-return-actions.1 → 1.0.0-emoji-shortcode.1

package/dist/types/ModRemovePost.d.ts

@@ -8,7 +8,7 @@ export type ModRemovePost = {
     id: ModRemovePostId;
     mod_person_id: PersonId;
     post_id: PostId;
-    reason?: string;
+    reason: string;
     removed: boolean;
     published_at: string;
 };

package/dist/types/ModlogActionType.d.ts

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

package/dist/types/ModlogCombinedView.d.ts

@@ -1,18 +1,19 @@
+import type { AdminAddView } from "./AdminAddView";
 import type { AdminAllowInstanceView } from "./AdminAllowInstanceView";
+import type { AdminBanView } from "./AdminBanView";
 import type { AdminBlockInstanceView } from "./AdminBlockInstanceView";
 import type { AdminPurgeCommentView } from "./AdminPurgeCommentView";
 import type { AdminPurgeCommunityView } from "./AdminPurgeCommunityView";
 import type { AdminPurgePersonView } from "./AdminPurgePersonView";
 import type { AdminPurgePostView } from "./AdminPurgePostView";
-import type { ModAddCommunityView } from "./ModAddCommunityView";
-import type { ModAddView } from "./ModAddView";
+import type { AdminRemoveCommunityView } from "./AdminRemoveCommunityView";
+import type { ModAddToCommunityView } from "./ModAddToCommunityView";
 import type { ModBanFromCommunityView } from "./ModBanFromCommunityView";
-import type { ModBanView } from "./ModBanView";
 import type { ModChangeCommunityVisibilityView } from "./ModChangeCommunityVisibilityView";
 import type { ModFeaturePostView } from "./ModFeaturePostView";
+import type { ModLockCommentView } from "./ModLockCommentView";
 import type { ModLockPostView } from "./ModLockPostView";
 import type { ModRemoveCommentView } from "./ModRemoveCommentView";
-import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
 import type { ModRemovePostView } from "./ModRemovePostView";
 import type { ModTransferCommunityView } from "./ModTransferCommunityView";
 export type ModlogCombinedView = ({
@@ -28,12 +29,12 @@ export type ModlogCombinedView = ({
 } & AdminPurgePersonView) | ({
     type_: "AdminPurgePost";
 } & AdminPurgePostView) | ({
-    type_: "ModAdd";
-} & ModAddView) | ({
-    type_: "ModAddCommunity";
-} & ModAddCommunityView) | ({
-    type_: "ModBan";
-} & ModBanView) | ({
+    type_: "AdminAdd";
+} & AdminAddView) | ({
+    type_: "ModAddToCommunity";
+} & ModAddToCommunityView) | ({
+    type_: "AdminBan";
+} & AdminBanView) | ({
     type_: "ModBanFromCommunity";
 } & ModBanFromCommunityView) | ({
     type_: "ModFeaturePost";
@@ -44,9 +45,11 @@ export type ModlogCombinedView = ({
 } & ModLockPostView) | ({
     type_: "ModRemoveComment";
 } & ModRemoveCommentView) | ({
-    type_: "ModRemoveCommunity";
-} & ModRemoveCommunityView) | ({
+    type_: "AdminRemoveCommunity";
+} & AdminRemoveCommunityView) | ({
     type_: "ModRemovePost";
 } & ModRemovePostView) | ({
     type_: "ModTransferCommunity";
-} & ModTransferCommunityView);
+} & ModTransferCommunityView) | ({
+    type_: "ModLockComment";
+} & ModLockCommentView);

package/dist/types/MyUserInfo.d.ts

@@ -13,7 +13,8 @@ export type MyUserInfo = {
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
     community_blocks: Array<Community>;
-    instance_blocks: Array<Instance>;
+    instance_communities_blocks: Array<Instance>;
+    instance_persons_blocks: Array<Instance>;
     person_blocks: Array<Person>;
     keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;

package/dist/types/Notification.d.ts

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

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

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

package/dist/types/NotificationType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Types of notifications which can be received in inbox
+ */
+export type NotificationType = "Mention" | "Reply" | "Subscribed" | "PrivateMessage";

package/dist/types/NotificationType.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/NotificationView.d.ts

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

package/dist/types/OpenGraphData.d.ts

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

package/dist/types/PersonActions.d.ts

@@ -11,4 +11,16 @@ export type PersonActions = {
      * A note about the person.
      */
     note?: string;
+    /**
+     * When the person was voted on.
+     */
+    voted_at?: string;
+    /**
+     * A total of upvotes given to this person
+     */
+    upvotes?: number;
+    /**
+     * A total of downvotes given to this person
+     */
+    downvotes?: number;
 };

package/dist/types/PersonView.d.ts

@@ -7,5 +7,6 @@ export type PersonView = {
     person: Person;
     is_admin: boolean;
     person_actions?: PersonActions;
-    creator_banned: boolean;
+    banned: boolean;
+    ban_expires_at?: string;
 };

package/dist/types/Post.d.ts

@@ -94,4 +94,6 @@ export type Post = {
      * accepted by the community (by receiving it back via federation).
      */
     federation_pending: boolean;
+    embed_video_width?: number;
+    embed_video_height?: number;
 };

package/dist/types/PostActions.d.ts

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

package/dist/types/PostActions.js

@@ -1,3 +1,2 @@
 "use strict";
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 Object.defineProperty(exports, "__esModule", { value: true });

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

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

package/dist/types/PostReportView.d.ts

@@ -19,4 +19,7 @@ export type PostReportView = {
     person_actions?: PersonActions;
     resolver?: Person;
     creator_is_admin: boolean;
+    creator_is_moderator: boolean;
+    creator_banned: boolean;
+    creator_banned_from_community: boolean;
 };

package/dist/types/PostView.d.ts

@@ -1,7 +1,6 @@
 import type { Community } from "./Community";
 import type { CommunityActions } from "./CommunityActions";
 import type { ImageDetails } from "./ImageDetails";
-import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
@@ -18,11 +17,12 @@ export type PostView = {
     community_actions?: CommunityActions;
     person_actions?: PersonActions;
     post_actions?: PostActions;
-    instance_actions?: InstanceActions;
     creator_is_admin: boolean;
     tags: TagsView;
     can_mod: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
     creator_is_moderator: boolean;
     creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };

package/dist/types/PrivateMessage.d.ts

@@ -10,7 +10,6 @@ export type PrivateMessage = {
     recipient_id: PersonId;
     content: string;
     deleted: boolean;
-    read: boolean;
     published_at: string;
     updated_at?: string;
     ap_id: DbUrl;

package/dist/types/PrivateMessageReportView.d.ts

@@ -10,4 +10,6 @@ export type PrivateMessageReportView = {
     creator: Person;
     private_message_creator: Person;
     resolver?: Person;
+    creator_is_admin: boolean;
+    creator_banned: boolean;
 };

package/dist/types/PurgeComment.d.ts

@@ -4,5 +4,5 @@ import type { CommentId } from "./CommentId";
  */
 export type PurgeComment = {
     comment_id: CommentId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgeCommunity.d.ts

@@ -4,5 +4,5 @@ import type { CommunityId } from "./CommunityId";
  */
 export type PurgeCommunity = {
     community_id: CommunityId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePerson.d.ts

@@ -4,5 +4,5 @@ import type { PersonId } from "./PersonId";
  */
 export type PurgePerson = {
     person_id: PersonId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePost.d.ts

@@ -4,5 +4,5 @@ import type { PostId } from "./PostId";
  */
 export type PurgePost = {
     post_id: PostId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/ReadableFederationState.d.ts

@@ -4,7 +4,7 @@ export type ReadableFederationState = {
     /**
      * timestamp of the next retry attempt (null if fail count is 0)
      */
-    next_retry?: string;
+    next_retry_at?: string;
     instance_id: InstanceId;
     /**
      * the last successfully sent activity id

package/dist/types/RemoveComment.d.ts

@@ -5,5 +5,5 @@ import type { CommentId } from "./CommentId";
 export type RemoveComment = {
     comment_id: CommentId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemoveCommunity.d.ts

@@ -5,5 +5,5 @@ import type { CommunityId } from "./CommunityId";
 export type RemoveCommunity = {
     community_id: CommunityId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemovePost.d.ts

@@ -5,5 +5,5 @@ import type { PostId } from "./PostId";
 export type RemovePost = {
     post_id: PostId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/SaveUserSettings.d.ts

@@ -37,6 +37,10 @@ export type SaveUserSettings = {
      * A default time range limit to apply to post sorts, in seconds. 0 means none.
      */
     default_post_time_range_seconds?: number;
+    /**
+     * A default fetch limit for number of items returned.
+     */
+    default_items_per_page?: number;
     /**
      * The default comment sort, usually "hot"
      */
@@ -94,10 +98,6 @@ export type SaveUserSettings = {
      * Enable infinite scroll
      */
     infinite_scroll_enabled?: boolean;
-    /**
-     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
-     */
-    enable_keyboard_navigation?: boolean;
     /**
      * Whether user avatars or inline images in the UI that are gifs should be allowed to play or
      * should be paused
@@ -114,7 +114,7 @@ export type SaveUserSettings = {
     /**
      * Some vote display mode settings
      */
-    show_scores?: boolean;
+    show_score?: boolean;
     show_upvotes?: boolean;
     show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;
@@ -126,4 +126,8 @@ export type SaveUserSettings = {
      * Whether to hide posts containing images/videos.
      */
     hide_media?: boolean;
+    /**
+     * Whether to show vote totals given to others.
+     */
+    show_person_votes?: boolean;
 };

package/dist/types/Tag.d.ts

@@ -2,25 +2,17 @@ import type { CommunityId } from "./CommunityId";
 import type { DbUrl } from "./DbUrl";
 import type { TagId } from "./TagId";
 /**
- * A tag that can be assigned to a post within a community.
- * The tag object is created by the community moderators.
- * The assignment happens by the post creator and can be updated by the community moderators.
- *
- * A tag is a federatable object that gives additional context to another object, which can be
- * displayed and filtered on. Currently, we only have community post tags, which is a tag that is
- * created by the mods of a community, then assigned to posts by post authors as well as mods of a
- * community, to categorize a post.
- *
- * In the future we may add more tag types, depending on the requirements, this will lead to either
- * expansion of this table (community_id optional, addition of tag_type enum) or split of this
- * table / creation of new tables.
+ * A tag that is created by community moderators, and assigned to posts by the creator
+ * or by mods.
  */
 export type Tag = {
     id: TagId;
     ap_id: DbUrl;
-    display_name: string;
+    name: string;
+    display_name?: string;
+    description?: string;
     /**
-     * the community that owns this tag
+     * The community that this tag belongs to
      */
     community_id: CommunityId;
     published_at: string;

package/dist/types/TagsView.d.ts

@@ -1,5 +1,5 @@
 import type { Tag } from "./Tag";
 /**
- * we wrap this in a struct so we can implement FromSqlRow<Json> for it
+ * We wrap this in a struct so we can implement FromSqlRow<Json> for it
  */
 export type TagsView = Array<Tag>;

package/dist/types/UpdateCommunityNotifications.d.ts

@@ -0,0 +1,9 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
+/**
+ * Change notification settings for a community
+ */
+export type UpdateCommunityNotifications = {
+    community_id: CommunityId;
+    mode: CommunityNotificationsMode;
+};

package/dist/types/UpdateCommunityTag.d.ts

@@ -1,8 +1,9 @@
 import type { TagId } from "./TagId";
 /**
- * Update a community tag.
+ * Make changes to a community tag
  */
 export type UpdateCommunityTag = {
     tag_id: TagId;
-    display_name: string;
+    display_name?: string;
+    description?: string;
 };

package/dist/types/UpdatePostNotifications.d.ts

@@ -0,0 +1,9 @@
+import type { PostId } from "./PostId";
+import type { PostNotificationsMode } from "./PostNotificationsMode";
+/**
+ * Change notification settings for a post
+ */
+export type UpdatePostNotifications = {
+    post_id: PostId;
+    mode: PostNotificationsMode;
+};

package/dist/types/UserBlockInstanceCommunitiesParams.d.ts

@@ -0,0 +1,8 @@
+import type { InstanceId } from "./InstanceId";
+/**
+ * Block an instance's communities.
+ */
+export type UserBlockInstanceCommunitiesParams = {
+    instance_id: InstanceId;
+    block: boolean;
+};

package/dist/types/UserBlockInstanceCommunitiesParams.js

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

package/dist/types/{UserBlockInstanceParams.d.ts → UserBlockInstancePersonsParams.d.ts}

@@ -1,8 +1,8 @@
 import type { InstanceId } from "./InstanceId";
 /**
- * Block an instance as user
+ * Block an instance's persons.
  */
-export type UserBlockInstanceParams = {
+export type UserBlockInstancePersonsParams = {
     instance_id: InstanceId;
     block: boolean;
 };

package/dist/types/UserBlockInstancePersonsParams.js

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

package/dist/types/UserSettingsBackup.d.ts

@@ -0,0 +1,27 @@
+import type { LocalUser } from "./LocalUser";
+/**
+ * Backup of user data. This struct should never be changed so that the data can be used as a
+ * long-term backup in case the instance goes down unexpectedly. All fields are optional to allow
+ * importing partial backups.
+ *
+ * This data should not be parsed by apps/clients, but directly downloaded as a file.
+ *
+ * Be careful with any changes to this struct, to avoid breaking changes which could prevent
+ * importing older backups.
+ */
+export type UserSettingsBackup = {
+    display_name?: string;
+    bio?: string;
+    avatar?: string;
+    banner?: string;
+    matrix_id?: string;
+    bot_account?: boolean;
+    settings?: LocalUser;
+    followed_communities: Array<string>;
+    saved_posts: Array<string>;
+    saved_comments: Array<string>;
+    blocked_communities: Array<string>;
+    blocked_users: Array<string>;
+    blocked_instances_communities: Array<string>;
+    blocked_instances_persons: Array<string>;
+};

package/dist/types/UserSettingsBackup.js

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

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-dont-return-actions.1",
+  "version": "1.0.0-emoji-shortcode.1",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -24,26 +24,27 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",
-    "@redocly/cli": "^1.27.2",
+    "@redocly/cli": "^2.0.0",
     "@types/node": "^22.7.4",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
     "@typescript-eslint/parser": "^8.7.0",
+    "ajv": "^8.17.1",
     "eslint": "^9.11.1",
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
-    "joi": "^17.13.3",
+    "joi": "^18.0.0",
     "lint-staged": "^16.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-import-sort": "^0.0.7",
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
-    "sortpack": "^2.4.0",
+    "sortpack": "^3.0.0",
     "tsoa": "^6.6.0",
     "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.12.1",
+  "packageManager": "pnpm@10.16.1",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/CommentReply.d.ts

@@ -1,13 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommentReplyId } from "./CommentReplyId";
-import type { PersonId } from "./PersonId";
-/**
- * A comment reply.
- */
-export type CommentReply = {
-    id: CommentReplyId;
-    recipient_id: PersonId;
-    comment_id: CommentId;
-    read: boolean;
-    published_at: string;
-};

package/dist/types/CommentReplyId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The comment reply id.
- */
-export type CommentReplyId = number;

package/dist/types/CommentReplyView.d.ts

@@ -1,31 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentActions } from "./CommentActions";
-import type { CommentReply } from "./CommentReply";
-import type { Community } from "./Community";
-import type { CommunityActions } from "./CommunityActions";
-import type { InstanceActions } from "./InstanceActions";
-import type { Person } from "./Person";
-import type { PersonActions } from "./PersonActions";
-import type { Post } from "./Post";
-import type { TagsView } from "./TagsView";
-/**
- * A comment reply view.
- */
-export type CommentReplyView = {
-    comment_reply: CommentReply;
-    recipient: Person;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    community_actions?: CommunityActions;
-    comment_actions?: CommentActions;
-    person_actions?: PersonActions;
-    instance_actions?: InstanceActions;
-    creator_is_admin: boolean;
-    post_tags: TagsView;
-    can_mod: boolean;
-    creator_banned: boolean;
-    creator_is_moderator: boolean;
-    creator_banned_from_community: boolean;
-};

package/dist/types/InboxCombinedView.d.ts

@@ -1,13 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-import type { PersonCommentMentionView } from "./PersonCommentMentionView";
-import type { PersonPostMentionView } from "./PersonPostMentionView";
-import type { PrivateMessageView } from "./PrivateMessageView";
-export type InboxCombinedView = ({
-    type_: "CommentReply";
-} & CommentReplyView) | ({
-    type_: "CommentMention";
-} & PersonCommentMentionView) | ({
-    type_: "PostMention";
-} & PersonPostMentionView) | ({
-    type_: "PrivateMessage";
-} & PrivateMessageView);