lemmy-js-client 1.0.0-block-nsfw.1 → 1.0.0-comment-lock.0

package/dist/types/UpdateCommunityTag.d.ts

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

package/dist/types/UpdateCommunityTag.js

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

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,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-block-nsfw.1",
+  "version": "1.0.0-comment-lock.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -19,28 +19,32 @@
     "type": "git",
     "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
   },
+  "dependencies": {
+    "@tsoa/runtime": "^6.6.0"
+  },
   "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",
     "prettier-plugin-packagejson": "^2.5.1",
     "sortpack": "^2.4.0",
     "tsoa": "^6.6.0",
-    "typedoc": "^0.27.0",
+    "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.4.0",
+  "packageManager": "pnpm@10.14.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/BannedPersonsResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * The list of banned persons.
- */
-export type BannedPersonsResponse = {
-    banned: Array<PersonView>;
-};

package/dist/types/CommentAggregates.d.ts

@@ -1,17 +0,0 @@
-import type { CommentId } from "./CommentId";
-/**
- * Aggregate data for a comment.
- */
-export type CommentAggregates = {
-    comment_id: CommentId;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    /**
-     * The total number of children in this comment branch.
-     */
-    child_count: number;
-    report_count: number;
-    unresolved_report_count: number;
-};

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,31 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentAggregates } from "./CommentAggregates";
-import type { CommentReply } from "./CommentReply";
-import type { Community } from "./Community";
-import type { Person } from "./Person";
-import type { Post } from "./Post";
-import type { SubscribedType } from "./SubscribedType";
-/**
- * A comment reply view.
- */
-export type CommentReplyView = {
-    comment_reply: CommentReply;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    recipient: Person;
-    counts: CommentAggregates;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
-    creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    /**
-     * The time when the comment was saved.
-     */
-    saved?: string;
-    creator_blocked: boolean;
-    my_vote?: number;
-    can_mod: boolean;
-};

package/dist/types/CommunityAggregates.d.ts

@@ -1,30 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-/**
- * Aggregate data for a community.
- */
-export type CommunityAggregates = {
-    community_id: CommunityId;
-    subscribers: number;
-    posts: number;
-    comments: number;
-    published: string;
-    /**
-     * The number of users with any activity in the last day.
-     */
-    users_active_day: number;
-    /**
-     * The number of users with any activity in the last week.
-     */
-    users_active_week: number;
-    /**
-     * The number of users with any activity in the last month.
-     */
-    users_active_month: number;
-    /**
-     * The number of users with any activity in the last year.
-     */
-    users_active_half_year: number;
-    subscribers_local: number;
-    report_count: number;
-    unresolved_report_count: number;
-};

package/dist/types/InboxCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the report_combined table
- */
-export type InboxCombinedPaginationCursor = string;

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

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

package/dist/types/ListInboxResponse.d.ts

@@ -1,7 +0,0 @@
-import type { InboxCombinedView } from "./InboxCombinedView";
-/**
- * Get your inbox (replies, comment mentions, post mentions, and messages)
- */
-export type ListInboxResponse = {
-    inbox: Array<InboxCombinedView>;
-};

package/dist/types/LocalUserVoteDisplayMode.d.ts

@@ -1,9 +0,0 @@
-/**
- * The vote display settings for your user.
- */
-export type LocalUserVoteDisplayMode = {
-    score: boolean;
-    upvotes: boolean;
-    downvotes: boolean;
-    upvote_percentage: boolean;
-};

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

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

package/dist/types/ModHideCommunityId.d.ts

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

package/dist/types/ModHideCommunityView.d.ts

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

package/dist/types/ModlogCombinedPaginationCursor.d.ts

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

package/dist/types/PersonAggregates.d.ts

@@ -1,10 +0,0 @@
-import type { PersonId } from "./PersonId";
-/**
- * Aggregate data for a person.
- */
-export type PersonAggregates = {
-    person_id: PersonId;
-    post_count: number;
-    comment_count: number;
-    published: string;
-};

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,31 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentAggregates } from "./CommentAggregates";
-import type { Community } from "./Community";
-import type { Person } from "./Person";
-import type { PersonCommentMention } from "./PersonCommentMention";
-import type { Post } from "./Post";
-import type { SubscribedType } from "./SubscribedType";
-/**
- * A person comment mention view.
- */
-export type PersonCommentMentionView = {
-    person_comment_mention: PersonCommentMention;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    recipient: Person;
-    counts: CommentAggregates;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
-    creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    /**
-     * The time when the comment was saved.
-     */
-    saved?: string;
-    creator_blocked: boolean;
-    my_vote?: number;
-    can_mod: boolean;
-};

package/dist/types/PersonContentCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the person_content_combined table
- */
-export type PersonContentCombinedPaginationCursor = string;

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;

package/dist/types/PersonPostMentionView.d.ts

@@ -1,36 +0,0 @@
-import type { Community } from "./Community";
-import type { ImageDetails } from "./ImageDetails";
-import type { Person } from "./Person";
-import type { PersonPostMention } from "./PersonPostMention";
-import type { Post } from "./Post";
-import type { PostAggregates } from "./PostAggregates";
-import type { PostTags } from "./PostTags";
-import type { SubscribedType } from "./SubscribedType";
-/**
- * A person post mention view.
- */
-export type PersonPostMentionView = {
-    person_post_mention: PersonPostMention;
-    post: Post;
-    creator: Person;
-    community: Community;
-    image_details?: ImageDetails;
-    recipient: Person;
-    counts: PostAggregates;
-    creator_banned_from_community: boolean;
-    banned_from_community: boolean;
-    creator_is_moderator: boolean;
-    creator_is_admin: boolean;
-    subscribed: SubscribedType;
-    /**
-     * The time when the post was saved.
-     */
-    saved?: string;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    post_tags: PostTags;
-    can_mod: boolean;
-};

package/dist/types/PersonSavedCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the person_saved_combined table
- */
-export type PersonSavedCombinedPaginationCursor = string;

package/dist/types/PostAggregates.d.ts

@@ -1,18 +0,0 @@
-import type { PostId } from "./PostId";
-/**
- * Aggregate data for a post.
- */
-export type PostAggregates = {
-    post_id: PostId;
-    comments: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    published: string;
-    /**
-     * The time of the newest comment in the post.
-     */
-    newest_comment_time: string;
-    report_count: number;
-    unresolved_report_count: number;
-};

package/dist/types/PostTags.d.ts

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

package/dist/types/ReportCombinedPaginationCursor.d.ts

@@ -1,4 +0,0 @@
-/**
- * like PaginationCursor but for the report_combined table
- */
-export type ReportCombinedPaginationCursor = string;

package/dist/types/ResolveObjectResponse.d.ts

@@ -1,13 +0,0 @@
-import type { CommentView } from "./CommentView";
-import type { CommunityView } from "./CommunityView";
-import type { PersonView } from "./PersonView";
-import type { PostView } from "./PostView";
-/**
- * The response of an apub object fetch.
- */
-export type ResolveObjectResponse = {
-    comment?: CommentView;
-    post?: PostView;
-    community?: CommunityView;
-    person?: PersonView;
-};

package/dist/types/SearchCombinedPaginationCursor.d.ts

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

package/dist/types/SiteAggregates.d.ts

@@ -1,27 +0,0 @@
-import type { SiteId } from "./SiteId";
-/**
- * Aggregate data for a site.
- */
-export type SiteAggregates = {
-    site_id: SiteId;
-    users: number;
-    posts: number;
-    comments: number;
-    communities: number;
-    /**
-     * The number of users with any activity in the last day.
-     */
-    users_active_day: number;
-    /**
-     * The number of users with any activity in the last week.
-     */
-    users_active_week: number;
-    /**
-     * The number of users with any activity in the last month.
-     */
-    users_active_month: number;
-    /**
-     * The number of users with any activity in the last half year.
-     */
-    users_active_half_year: number;
-};

package/dist/types/SubscribedType.d.ts

@@ -1,4 +0,0 @@
-/**
- * A type / status for a community subscribe.
- */
-export type SubscribedType = "Subscribed" | "NotSubscribed" | "Pending" | "ApprovalRequired";