lemmy-js-client 1.0.0-alpha.1 → 1.0.0-comment-lock.0

package/dist/types/PostReport.d.ts

@@ -24,7 +24,7 @@ export type PostReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     violates_instance_rules: boolean;
 };

package/dist/types/PostReportView.d.ts

@@ -14,10 +14,12 @@ export type PostReportView = {
     community: Community;
     creator: Person;
     post_creator: Person;
-    creator_community_actions?: CommunityActions;
     community_actions?: CommunityActions;
     post_actions?: PostActions;
     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,12 +17,10 @@ export type PostView = {
     community_actions?: CommunityActions;
     person_actions?: PersonActions;
     post_actions?: PostActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
     creator_is_admin: boolean;
     tags: TagsView;
     can_mod: boolean;
     creator_banned: boolean;
+    creator_is_moderator: boolean;
+    creator_banned_from_community: boolean;
 };

package/dist/types/PrivateMessage.d.ts

@@ -10,9 +10,8 @@ export type PrivateMessage = {
     recipient_id: PersonId;
     content: string;
     deleted: boolean;
-    read: boolean;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     ap_id: DbUrl;
     local: boolean;
     removed: boolean;

package/dist/types/PrivateMessageReport.d.ts

@@ -15,6 +15,6 @@ export type PrivateMessageReport = {
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
 };

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

@@ -10,7 +10,7 @@ export type ReadableFederationState = {
      * the last successfully sent activity id
      */
     last_successful_id?: ActivityId;
-    last_successful_published_time?: string;
+    last_successful_published_time_at?: string;
     /**
      * how many failed attempts have been made to send the next activity
      */
@@ -18,5 +18,5 @@ export type ReadableFederationState = {
     /**
      * timestamp of the last retry attempt (when the last failing activity was resent)
      */
-    last_retry?: string;
+    last_retry_at?: string;
 };

package/dist/types/RegistrationApplication.d.ts

@@ -10,5 +10,5 @@ export type RegistrationApplication = {
     answer: string;
     admin_id?: PersonId;
     deny_reason?: string;
-    published: string;
+    published_at: string;
 };

package/dist/types/SaveUserSettings.d.ts

@@ -4,6 +4,7 @@ import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { SensitiveString } from "./SensitiveString";
+import type { VoteShow } from "./VoteShow";
 /**
  * Saves settings for your user.
  */
@@ -115,7 +116,7 @@ export type SaveUserSettings = {
      */
     show_scores?: boolean;
     show_upvotes?: boolean;
-    show_downvotes?: boolean;
+    show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;
     /**
      * Whether to automatically mark fetched posts as read.
@@ -125,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/Search.d.ts

@@ -8,7 +8,7 @@ import type { SearchType } from "./SearchType";
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    search_term?: string;
+    q: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
@@ -24,6 +24,10 @@ export type Search = {
     post_url_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
+    /**
+     * If true, then show the nsfw posts (even if your user setting is to hide them)
+     */
+    show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
     limit?: number;

package/dist/types/SearchCombinedView.d.ts

@@ -1,5 +1,6 @@
 import type { CommentView } from "./CommentView";
 import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 export type SearchCombinedView = ({
@@ -10,4 +11,6 @@ export type SearchCombinedView = ({
     type_: "Community";
 } & CommunityView) | ({
     type_: "Person";
-} & PersonView);
+} & PersonView) | ({
+    type_: "MultiCommunity";
+} & MultiCommunityView);

package/dist/types/SearchType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The type of content returned from a search.
  */
-export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users";
+export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users" | "MultiCommunities";

package/dist/types/Site.d.ts

@@ -2,7 +2,8 @@ import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { SiteId } from "./SiteId";
 /**
- * The site.
+ * Additional data for federated instances. This may be missing for other platforms which are not
+ * fully compatible. Basic data is guaranteed to be available via [[Instance]].
  */
 export type Site = {
     id: SiteId;
@@ -11,8 +12,8 @@ export type Site = {
      * A sidebar for the site in markdown.
      */
     sidebar?: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     /**
      * An icon URL.
      */

package/dist/types/SiteResponse.d.ts

@@ -4,8 +4,4 @@ import type { SiteView } from "./SiteView";
  */
 export type SiteResponse = {
     site_view: SiteView;
-    /**
-     * deprecated, use field `tagline` or /api/v4/tagline/list
-     */
-    taglines: Array<null>;
 };

package/dist/types/Tag.d.ts

@@ -2,28 +2,20 @@ 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: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     deleted: boolean;
 };

package/dist/types/Tagline.d.ts

@@ -5,6 +5,6 @@ import type { TaglineId } from "./TaglineId";
 export type Tagline = {
     id: TaglineId;
     content: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_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/UpdateCommunityNotifications.js

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

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

@@ -0,0 +1,7 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type UpdateMultiCommunity = {
+    id: MultiCommunityId;
+    title?: string;
+    description?: string;
+    deleted?: boolean;
+};

package/dist/types/UpdateMultiCommunity.js

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

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/UpdatePostNotifications.js

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

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,31 @@
+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>;
+    /**
+     * Only kept for v0.19 compatibility
+     */
+    blocked_instances: 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/VoteShow.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Lets you show votes for others only, show all votes, or hide all votes.
+ */
+export type VoteShow = "Show" | "ShowForOthers" | "Hide";

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

@@ -4,7 +4,7 @@ import type { Person } from "./Person";
  */
 export type VoteView = {
     creator: Person;
-    item_id: number;
+    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-alpha.1",
+  "version": "1.0.0-comment-lock.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -24,15 +24,16 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",
-    "@redocly/cli": "^1.27.2",
-    "@types/joi": "^17.2.3",
+    "@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",
-    "lint-staged": "^15.2.7",
+    "joi": "^17.13.3",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-import-sort": "^0.0.7",
     "prettier-plugin-organize-imports": "^4.0.0",
@@ -43,7 +44,7 @@
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.8.0",
+  "packageManager": "pnpm@10.14.0",
   "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: 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,32 +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_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
-    creator_is_admin: boolean;
-    post_tags: TagsView;
-    can_mod: boolean;
-    creator_banned: 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);

package/dist/types/InboxDataType.d.ts

@@ -1,4 +0,0 @@
-/**
- * A list of possible types for the inbox.
- */
-export type InboxDataType = "All" | "CommentReply" | "CommentMention" | "PostMention" | "PrivateMessage";

package/dist/types/MarkCommentReplyAsRead.d.ts

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

package/dist/types/MarkPersonCommentMentionAsRead.d.ts

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

package/dist/types/MarkPersonPostMentionAsRead.d.ts

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

package/dist/types/PersonCommentMention.d.ts

@@ -1,13 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { PersonCommentMentionId } from "./PersonCommentMentionId";
-import type { PersonId } from "./PersonId";
-/**
- * A person mention.
- */
-export type PersonCommentMention = {
-    id: PersonCommentMentionId;
-    recipient_id: PersonId;
-    comment_id: CommentId;
-    read: boolean;
-    published: string;
-};

package/dist/types/PersonCommentMentionId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The person comment mention id.
- */
-export type PersonCommentMentionId = number;

package/dist/types/PersonCommentMentionView.d.ts

@@ -1,30 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentActions } from "./CommentActions";
-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 { PersonCommentMention } from "./PersonCommentMention";
-import type { Post } from "./Post";
-/**
- * A person comment mention view.
- */
-export type PersonCommentMentionView = {
-    person_comment_mention: PersonCommentMention;
-    recipient: Person;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    community_actions?: CommunityActions;
-    comment_actions?: CommentActions;
-    person_actions?: PersonActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
-    creator_is_admin: boolean;
-    can_mod: boolean;
-    creator_banned: boolean;
-};

package/dist/types/PersonPostMention.d.ts

@@ -1,13 +0,0 @@
-import type { PersonId } from "./PersonId";
-import type { PersonPostMentionId } from "./PersonPostMentionId";
-import type { PostId } from "./PostId";
-/**
- * A person mention.
- */
-export type PersonPostMention = {
-    id: PersonPostMentionId;
-    recipient_id: PersonId;
-    post_id: PostId;
-    read: boolean;
-    published: string;
-};

package/dist/types/PersonPostMentionId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The person post mention id.
- */
-export type PersonPostMentionId = number;