lemmy-js-client 1.0.0-action-structs.0 → 1.0.0-add-liked.0

package/dist/types/LocalSite.d.ts

@@ -41,10 +41,6 @@ export type LocalSite = {
      * An optional legal disclaimer page.
      */
     legal_information?: string;
-    /**
-     * Whether to hide mod names on the modlog.
-     */
-    hide_modlog_mod_names: boolean;
     /**
      * Whether new applications email admins.
      */
@@ -113,15 +109,14 @@ export type LocalSite = {
      * What kind of comment downvotes your site allows.
      */
     comment_downvotes: FederationMode;
-    /**
-     * If this is true, users will never see the dialog asking to support Lemmy development with
-     * donations.
-     */
-    disable_donation_dialog: boolean;
     /**
      * A default time range limit to apply to post sorts, in seconds.
      */
     default_post_time_range_seconds?: number;
+    /**
+     * Block NSFW content being created
+     */
+    disallow_nsfw_content: boolean;
     users: number;
     posts: number;
     comments: number;
@@ -143,7 +138,7 @@ export type LocalSite = {
      */
     users_active_half_year: number;
     /**
-     * Block NSFW content being created
+     * Dont send email notifications to users for new replies, mentions etc
      */
-    disallow_nsfw_content: boolean;
+    disable_email_notifications: boolean;
 };

package/dist/types/LocalUser.d.ts

@@ -5,6 +5,7 @@ import type { PersonId } from "./PersonId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { SensitiveString } from "./SensitiveString";
+import type { VoteShow } from "./VoteShow";
 /**
  * A local user.
  */
@@ -99,6 +100,6 @@ export type LocalUser = {
     default_post_time_range_seconds?: number;
     show_score: boolean;
     show_upvotes: boolean;
-    show_downvotes: boolean;
+    show_downvotes: VoteShow;
     show_upvote_percentage: boolean;
 };

package/dist/types/LocalUserView.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceActions } from "./InstanceActions";
 import type { LocalUser } from "./LocalUser";
 import type { Person } from "./Person";
 /**
@@ -6,4 +7,5 @@ import type { Person } from "./Person";
 export type LocalUserView = {
     local_user: LocalUser;
     person: Person;
+    instance_actions?: InstanceActions;
 };

package/dist/types/LockPost.d.ts

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

package/dist/types/Login.d.ts

@@ -1,6 +1,9 @@
 import type { SensitiveString } from "./SensitiveString";
 /**
  * Logging into lemmy.
+ *
+ * Note: Banned users can still log in, to be able to do certain things like delete
+ * their account.
  */
 export type Login = {
     username_or_email: SensitiveString;

package/dist/types/ModBan.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceId } from "./InstanceId";
 import type { ModBanId } from "./ModBanId";
 import type { PersonId } from "./PersonId";
 /**
@@ -11,4 +12,5 @@ export type ModBan = {
     banned: boolean;
     expires?: string;
     published: string;
+    instance_id: InstanceId;
 };

package/dist/types/ModChangeCommunityVisibility.d.ts

@@ -0,0 +1,11 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityVisibility } from "./CommunityVisibility";
+import type { ModChangeCommunityVisibilityId } from "./ModChangeCommunityVisibilityId";
+import type { PersonId } from "./PersonId";
+export type ModChangeCommunityVisibility = {
+    id: ModChangeCommunityVisibilityId;
+    community_id: CommunityId;
+    mod_person_id: PersonId;
+    published: string;
+    visibility: CommunityVisibility;
+};

package/dist/types/ModChangeCommunityVisibility.js

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

package/dist/types/ModChangeCommunityVisibilityId.d.ts

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

package/dist/types/ModChangeCommunityVisibilityView.d.ts

@@ -0,0 +1,11 @@
+import type { Community } from "./Community";
+import type { ModChangeCommunityVisibility } from "./ModChangeCommunityVisibility";
+import type { Person } from "./Person";
+/**
+ * When the visibility of a community is changed
+ */
+export type ModChangeCommunityVisibilityView = {
+    mod_change_community_visibility: ModChangeCommunityVisibility;
+    moderator?: Person;
+    community: Community;
+};

package/dist/types/ModChangeCommunityVisibilityView.js

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

package/dist/types/ModLockPost.d.ts

@@ -10,4 +10,5 @@ export type ModLockPost = {
     post_id: PostId;
     locked: boolean;
     published: string;
+    reason?: 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" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";
+export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModChangeCommunityVisibility" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";

package/dist/types/ModlogCombinedView.d.ts

@@ -8,8 +8,8 @@ import type { ModAddCommunityView } from "./ModAddCommunityView";
 import type { ModAddView } from "./ModAddView";
 import type { ModBanFromCommunityView } from "./ModBanFromCommunityView";
 import type { ModBanView } from "./ModBanView";
+import type { ModChangeCommunityVisibilityView } from "./ModChangeCommunityVisibilityView";
 import type { ModFeaturePostView } from "./ModFeaturePostView";
-import type { ModHideCommunityView } from "./ModHideCommunityView";
 import type { ModLockPostView } from "./ModLockPostView";
 import type { ModRemoveCommentView } from "./ModRemoveCommentView";
 import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
@@ -38,8 +38,8 @@ export type ModlogCombinedView = ({
 } & ModBanFromCommunityView) | ({
     type_: "ModFeaturePost";
 } & ModFeaturePostView) | ({
-    type_: "ModHideCommunity";
-} & ModHideCommunityView) | ({
+    type_: "ModChangeCommunityVisibility";
+} & ModChangeCommunityVisibilityView) | ({
     type_: "ModLockPost";
 } & ModLockPostView) | ({
     type_: "ModRemoveComment";

package/dist/types/MyUserInfo.d.ts

@@ -15,5 +15,6 @@ export type MyUserInfo = {
     community_blocks: Array<Community>;
     instance_blocks: Array<Instance>;
     person_blocks: Array<Person>;
+    keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;
 };

package/dist/types/PendingFollow.d.ts

@@ -1,9 +1,9 @@
 import type { Community } from "./Community";
+import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { Person } from "./Person";
-import type { SubscribedType } from "./SubscribedType";
 export type PendingFollow = {
     person: Person;
     community: Community;
     is_new_instance: boolean;
-    subscribed: SubscribedType;
+    follow_state?: CommunityFollowerState;
 };

package/dist/types/Person.d.ts

@@ -15,10 +15,6 @@ export type Person = {
      * A URL for an avatar.
      */
     avatar?: DbUrl;
-    /**
-     * Whether the person is banned.
-     */
-    banned: boolean;
     published: string;
     updated?: string;
     /**
@@ -49,10 +45,6 @@ export type Person = {
      * Whether the person is a bot account.
      */
     bot_account: boolean;
-    /**
-     * When their ban, if it exists, expires, if at all.
-     */
-    ban_expires?: string;
     instance_id: InstanceId;
     post_count: number;
     comment_count: number;

package/dist/types/PersonActions.d.ts

@@ -1,8 +1,6 @@
-import type { PersonId } from "./PersonId";
 export type PersonActions = {
-    target_id: PersonId;
-    person_id: PersonId;
-    followed?: string;
-    follow_pending?: boolean;
+    /**
+     * When the person was blocked.
+     */
     blocked?: string;
 };

package/dist/types/PersonActions.js

@@ -1,2 +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/PersonCommentMentionView.d.ts

@@ -21,7 +21,10 @@ export type PersonCommentMentionView = {
     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/PersonLikedCombinedView.d.ts

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

package/dist/types/PersonLikedCombinedView.js

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

package/dist/types/PersonPostMentionView.d.ts

@@ -7,6 +7,7 @@ import type { PersonActions } from "./PersonActions";
 import type { PersonPostMention } from "./PersonPostMention";
 import type { Post } from "./Post";
 import type { PostActions } from "./PostActions";
+import type { TagsView } from "./TagsView";
 /**
  * A person post mention view.
  */
@@ -21,7 +22,11 @@ export type PersonPostMentionView = {
     person_actions?: PersonActions;
     post_actions?: PostActions;
     instance_actions?: InstanceActions;
+    creator_home_instance_actions?: InstanceActions;
+    creator_local_instance_actions?: InstanceActions;
     creator_community_actions?: CommunityActions;
+    post_tags: TagsView;
     creator_is_admin: boolean;
     can_mod: boolean;
+    creator_banned: boolean;
 };

package/dist/types/PersonView.d.ts

@@ -1,3 +1,4 @@
+import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 /**
  * A person view.
@@ -5,4 +6,7 @@ import type { Person } from "./Person";
 export type PersonView = {
     person: Person;
     is_admin: boolean;
+    home_instance_actions?: InstanceActions;
+    local_instance_actions?: InstanceActions;
+    creator_banned: boolean;
 };

package/dist/types/PluginMetadata.d.ts

@@ -0,0 +1,5 @@
+export type PluginMetadata = {
+    name: string;
+    url: string;
+    description: string;
+};

package/dist/types/Post.d.ts

@@ -89,4 +89,9 @@ export type Post = {
     newest_comment_time: string;
     report_count: number;
     unresolved_report_count: number;
+    /**
+     * If a local user posts in a remote community, the comment is hidden until it is confirmed
+     * accepted by the community (by receiving it back via federation).
+     */
+    federation_pending: boolean;
 };

package/dist/types/PostActions.d.ts

@@ -1,13 +1,31 @@
-import type { PersonId } from "./PersonId";
-import type { PostId } from "./PostId";
 export type PostActions = {
-    post_id: PostId;
-    person_id: PersonId;
+    /**
+     * When the post was read.
+     */
     read?: string;
+    /**
+     * When was the last time you read the comments.
+     */
     read_comments?: string;
+    /**
+     * The number of comments you read last. Subtract this from total comments to get an unread
+     * count.
+     */
     read_comments_amount?: number;
+    /**
+     * When the post was saved.
+     */
     saved?: string;
+    /**
+     * When the post was liked.
+     */
     liked?: string;
+    /**
+     * The like / score of the post.
+     */
     like_score?: number;
+    /**
+     * When the post was hidden.
+     */
     hidden?: string;
 };

package/dist/types/PostActions.js

@@ -1,2 +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/PostView.d.ts

@@ -6,6 +6,7 @@ import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
 import type { PostActions } from "./PostActions";
+import type { TagsView } from "./TagsView";
 /**
  * A post view.
  */
@@ -18,7 +19,11 @@ export type PostView = {
     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;
 };

package/dist/types/ResolveCommunityReport.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityReportId } from "./CommunityReportId";
+/**
+ * Resolve a community report.
+ */
+export type ResolveCommunityReport = {
+    report_id: CommunityReportId;
+    resolved: boolean;
+};

package/dist/types/ResolveCommunityReport.js

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

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.
  */
@@ -84,6 +85,7 @@ export type SaveUserSettings = {
      * A list of languages you are able to see discussion in.
      */
     discussion_languages?: Array<LanguageId>;
+    blocking_keywords?: Array<string>;
     /**
      * Open links in a new tab
      */
@@ -114,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.

package/dist/types/Search.d.ts

@@ -24,6 +24,11 @@ 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/SearchResponse.d.ts

@@ -9,4 +9,5 @@ export type SearchResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

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;

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

@@ -1,3 +1,4 @@
+import type { Instance } from "./Instance";
 import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
@@ -8,4 +9,5 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
+    instance: Instance;
 };

package/dist/types/Tag.d.ts

@@ -7,16 +7,18 @@ import type { TagId } from "./TagId";
  * 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 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.
+ * 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.
  */
 export type Tag = {
     id: TagId;
     ap_id: DbUrl;
-    name: string;
+    display_name: string;
     /**
      * the community that owns this tag
      */

package/dist/types/Tagline.d.ts

@@ -1,8 +1,9 @@
+import type { TaglineId } from "./TaglineId";
 /**
  * A tagline, shown at the top of your site.
  */
 export type Tagline = {
-    id: number;
+    id: TaglineId;
     content: string;
     published: string;
     updated?: string;

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

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

package/dist/types/TagsView.js

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

package/dist/types/UpdateCommunityTag.d.ts

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

package/dist/types/UpdateCommunityTag.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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-action-structs.0",
+  "version": "1.0.0-add-liked.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -19,28 +19,31 @@
     "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",
     "@types/node": "^22.7.4",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
     "@typescript-eslint/parser": "^8.7.0",
     "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.5.2",
+  "packageManager": "pnpm@10.11.1",
   "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/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/PostPaginationCursor.d.ts

@@ -1,7 +0,0 @@
-/**
- * currently this is just a wrapper around post id, but should be seen as opaque from the client's
- * perspective. stringified since we might want to use arbitrary info later, with a P prepended to
- * prevent ossification (api users love to make assumptions (e.g. parse stuff that looks like
- * numbers as numbers) about apis that aren't part of the spec
- */
-export type PostPaginationCursor = string;