lemmy-js-client 1.0.0-post-tags.0 → 1.0.0-post-notifications.1

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.
      */
@@ -26,9 +27,9 @@ export type Site = {
      */
     description?: string;
     /**
-     * The federated actor_id.
+     * The federated ap_id.
      */
-    actor_id: DbUrl;
+    ap_id: DbUrl;
     /**
      * The time the site was last refreshed.
      */

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,7 +1,7 @@
+import type { Instance } from "./Instance";
 import type { LocalSite } from "./LocalSite";
 import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
 import type { Site } from "./Site";
-import type { SiteAggregates } from "./SiteAggregates";
 /**
  * A site view.
  */
@@ -9,5 +9,5 @@ export type SiteView = {
     site: Site;
     local_site: LocalSite;
     local_site_rate_limit: LocalSiteRateLimit;
-    counts: SiteAggregates;
+    instance: Instance;
 };

package/dist/types/Tag.d.ts

@@ -7,21 +7,23 @@ 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
      */
     community_id: CommunityId;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     deleted: boolean;
 };

package/dist/types/Tagline.d.ts

@@ -1,9 +1,10 @@
+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;
+    published_at: string;
+    updated_at?: 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/{PostTags.d.ts → TagsView.d.ts}

@@ -2,4 +2,4 @@ import type { Tag } from "./Tag";
 /**
  * we wrap this in a struct so we can implement FromSqlRow<Json> for it
  */
-export type PostTags = Array<Tag>;
+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/UpdateCommunityNotifications.d.ts

@@ -0,0 +1,9 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
+/**
+ * Disable reply notifications for a post and all comments inside it
+ */
+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

@@ -4,5 +4,5 @@ import type { TagId } from "./TagId";
  */
 export type UpdateCommunityTag = {
     tag_id: TagId;
-    name: string;
+    display_name: 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";
+/**
+ * Disable reply notifications for a post and all comments inside it
+ */
+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/UserSettingsBackup.d.ts

@@ -0,0 +1,26 @@
+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: 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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-post-tags.0",
+  "version": "1.0.0-post-notifications.1",
   "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.2.1",
+  "packageManager": "pnpm@10.12.4",
   "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/CommentReplyView.d.ts

@@ -1,27 +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;
-    saved: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-};

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

@@ -1,7 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-import type { TagId } from "./TagId";
-export type CommunityTagResponse = {
-    id: TagId;
-    name: string;
-    community_id: CommunityId;
-};

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

@@ -1,7 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-/**
- * List tags for a community.
- */
-export type ListCommunityTags = {
-    community_id: CommunityId;
-};

package/dist/types/ListCommunityTagsResponse.d.ts

@@ -1,4 +0,0 @@
-import type { CommunityTagResponse } from "./CommunityTagResponse";
-export type ListCommunityTagsResponse = {
-    tags: Array<CommunityTagResponse>;
-};

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,9 +0,0 @@
-import type { PersonId } from "./PersonId";
-/**
- * Aggregate data for a person.
- */
-export type PersonAggregates = {
-    person_id: PersonId;
-    post_count: number;
-    comment_count: number;
-};

package/dist/types/PersonCommentMentionView.d.ts

@@ -1,27 +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;
-    saved: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-};

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

@@ -1,32 +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;
-    saved: boolean;
-    read: boolean;
-    hidden: boolean;
-    creator_blocked: boolean;
-    my_vote?: number;
-    unread_comments: number;
-    post_tags: PostTags;
-};

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/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";

package/dist/types/UpdatePostTags.d.ts

@@ -1,9 +0,0 @@
-import type { PostId } from "./PostId";
-import type { TagId } from "./TagId";
-/**
- * Update tags for a post.
- */
-export type UpdatePostTags = {
-    post_id: PostId;
-    tags: Array<TagId>;
-};