lemmy-js-client 0.20.0-api-v4.17 → 0.20.0-api-no-optional-vec.0

package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts}

@@ -2,14 +2,14 @@ import type { Comment } from "./Comment";
 import type { CommentAggregates } from "./CommentAggregates";
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-import type { PersonMention } from "./PersonMention";
+import type { PersonCommentMention } from "./PersonCommentMention";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
 /**
- * A person mention view.
+ * A person comment mention view.
  */
-export type PersonMentionView = {
-    person_mention: PersonMention;
+export type PersonCommentMentionView = {
+    person_comment_mention: PersonCommentMention;
     comment: Comment;
     creator: Person;
     post: Post;
@@ -21,7 +21,11 @@ export type PersonMentionView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the comment was saved.
+     */
+    saved?: string;
     creator_blocked: boolean;
     my_vote?: number;
+    can_mod: boolean;
 };

package/dist/types/PersonCommentMentionView.js

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

package/dist/types/PersonContentCombinedPaginationCursor.d.ts

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

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

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

package/dist/types/PersonContentCombinedView.js

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

package/dist/types/PersonContentType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for a person's content.
+ */
+export type PersonContentType = "All" | "Comments" | "Posts";

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

@@ -0,0 +1,13 @@
+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/PersonPostMention.js

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

package/dist/types/PersonPostMentionId.d.ts

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

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

@@ -0,0 +1,36 @@
+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/PersonPostMentionView.js

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

package/dist/types/PersonSavedCombinedPaginationCursor.d.ts

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

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

@@ -26,4 +26,5 @@ export type PostReport = {
     resolver_id?: PersonId;
     published: string;
     updated?: string;
+    violates_instance_rules: boolean;
 };

package/dist/types/PostReportView.d.ts

@@ -17,7 +17,10 @@ export type PostReportView = {
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the post was saved.
+     */
+    saved?: string;
     read: boolean;
     hidden: boolean;
     creator_blocked: boolean;

package/dist/types/PostSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
  */
-export type PostSortType = "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled";
+export type PostSortType = "Active" | "Hot" | "New" | "Old" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";

package/dist/types/PostTags.d.ts

@@ -0,0 +1,7 @@
+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/PostTags.js

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

package/dist/types/PostView.d.ts

@@ -3,6 +3,7 @@ import type { ImageDetails } from "./ImageDetails";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
+import type { PostTags } from "./PostTags";
 import type { SubscribedType } from "./SubscribedType";
 /**
  * A post view.
@@ -18,10 +19,15 @@ export type PostView = {
     creator_is_admin: boolean;
     counts: PostAggregates;
     subscribed: SubscribedType;
-    saved: boolean;
+    /**
+     * The time when the post was saved.
+     */
+    saved?: string;
     read: boolean;
     hidden: boolean;
     creator_blocked: boolean;
     my_vote?: number;
     unread_comments: number;
+    tags: PostTags;
+    can_mod: boolean;
 };

package/dist/types/PrivateMessage.d.ts

@@ -15,4 +15,5 @@ export type PrivateMessage = {
     updated?: string;
     ap_id: DbUrl;
     local: boolean;
+    removed: boolean;
 };

package/dist/types/ReportCombinedPaginationCursor.d.ts

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

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

@@ -0,0 +1,13 @@
+import type { CommentReportView } from "./CommentReportView";
+import type { CommunityReportView } from "./CommunityReportView";
+import type { PostReportView } from "./PostReportView";
+import type { PrivateMessageReportView } from "./PrivateMessageReportView";
+export type ReportCombinedView = ({
+    type_: "Post";
+} & PostReportView) | ({
+    type_: "Comment";
+} & CommentReportView) | ({
+    type_: "PrivateMessage";
+} & PrivateMessageReportView) | ({
+    type_: "Community";
+} & CommunityReportView);

package/dist/types/ReportCombinedView.js

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

package/dist/types/ReportType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for reports.
+ */
+export type ReportType = "All" | "Posts" | "Comments" | "PrivateMessages" | "Communities";

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

@@ -0,0 +1,7 @@
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Make a request to resend your verification email.
+ */
+export type ResendVerificationEmail = {
+    email: SensitiveString;
+};

package/dist/types/ResendVerificationEmail.js

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

package/dist/types/SaveUserSettings.d.ts

@@ -32,6 +32,10 @@ export type SaveUserSettings = {
      * The default post sort, usually "active"
      */
     default_post_sort_type?: PostSortType;
+    /**
+     * A default time range limit to apply to post sorts, in seconds. 0 means none.
+     */
+    default_post_time_range_seconds?: number;
     /**
      * The default comment sort, usually "hot"
      */
@@ -40,14 +44,6 @@ export type SaveUserSettings = {
      * The language of the lemmy interface
      */
     interface_language?: string;
-    /**
-     * A URL for your avatar.
-     */
-    avatar?: string;
-    /**
-     * A URL for your banner.
-     */
-    banner?: string;
     /**
      * Your display name, which can contain strange characters, and does not need to be unique.
      */
@@ -87,7 +83,7 @@ export type SaveUserSettings = {
     /**
      * A list of languages you are able to see discussion in.
      */
-    discussion_languages?: Array<LanguageId>;
+    discussion_languages: Array<LanguageId>;
     /**
      * Open links in a new tab
      */
@@ -124,4 +120,8 @@ export type SaveUserSettings = {
      * Whether to automatically mark fetched posts as read.
      */
     auto_mark_fetched_posts_as_read?: boolean;
+    /**
+     * Whether to hide posts containing images/videos.
+     */
+    hide_media?: boolean;
 };

package/dist/types/Search.d.ts

@@ -1,24 +1,29 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PersonId } from "./PersonId";
-import type { PostSortType } from "./PostSortType";
+import type { SearchCombinedPaginationCursor } from "./SearchCombinedPaginationCursor";
+import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
 /**
- * Searches the site, given a query string, and some optional filters.
+ * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    q: string;
+    search_term?: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
     type_?: SearchType;
-    sort?: PostSortType;
+    sort?: SearchSortType;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     */
+    time_range_seconds?: number;
     listing_type?: ListingType;
-    page?: number;
-    limit?: number;
     title_only?: boolean;
     post_url_only?: boolean;
-    saved_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
+    page_cursor?: SearchCombinedPaginationCursor;
+    page_back?: boolean;
 };

package/dist/types/SearchCombinedPaginationCursor.d.ts

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

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

@@ -0,0 +1,13 @@
+import type { CommentView } from "./CommentView";
+import type { CommunityView } from "./CommunityView";
+import type { PersonView } from "./PersonView";
+import type { PostView } from "./PostView";
+export type SearchCombinedView = ({
+    type_: "Post";
+} & PostView) | ({
+    type_: "Comment";
+} & CommentView) | ({
+    type_: "Community";
+} & CommunityView) | ({
+    type_: "Person";
+} & PersonView);

package/dist/types/SearchCombinedView.js

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

package/dist/types/SearchResponse.d.ts

@@ -1,15 +1,7 @@
-import type { CommentView } from "./CommentView";
-import type { CommunityView } from "./CommunityView";
-import type { PersonView } from "./PersonView";
-import type { PostView } from "./PostView";
-import type { SearchType } from "./SearchType";
+import type { SearchCombinedView } from "./SearchCombinedView";
 /**
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
-    type_: SearchType;
-    comments: Array<CommentView>;
-    posts: Array<PostView>;
-    communities: Array<CommunityView>;
-    users: Array<PersonView>;
+    results: Array<SearchCombinedView>;
 };

package/dist/types/SearchSortType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The search sort types.
+ */
+export type SearchSortType = "New" | "Top" | "Old";

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

@@ -26,9 +26,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

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

package/dist/types/SuccessResponse.d.ts

@@ -1,5 +1,5 @@
 /**
- * Saves settings for your user.
+ * A response that completes successfully.
  */
 export type SuccessResponse = {
     success: boolean;

package/dist/types/Tag.d.ts

@@ -0,0 +1,27 @@
+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 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;
+    /**
+     * the community that owns this tag
+     */
+    community_id: CommunityId;
+    published: string;
+    updated?: string;
+    deleted: boolean;
+};

package/dist/types/Tag.js

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

package/dist/types/TagId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The internal tag id.
+ */
+export type TagId = number;

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

@@ -0,0 +1,4 @@
+export type UploadImageResponse = {
+    image_url: string;
+    filename: string;
+};

package/dist/types/UploadImageResponse.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,8 +1,8 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.20.0-api-v4.17",
-  "author": "Dessalines <tyhou13@gmx.com>",
+  "version": "0.20.0-api-no-optional-vec.0",
+  "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
   "files": [
@@ -12,13 +12,17 @@
     "build": "tsc",
     "docs": "typedoc src/index.ts",
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
-    "prepare": "pnpm run build && husky"
+    "prepare": "pnpm run build && husky",
+    "tsoa": "tsoa spec-and-routes && tsc && redocly build-docs tsoa_build/swagger.json"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
   },
   "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",
@@ -31,11 +35,12 @@
     "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",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@9.15.0",
+  "packageManager": "pnpm@10.4.1",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/CommentReplyResponse.d.ts

@@ -1,7 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-/**
- * The response for a comment reply action.
- */
-export type CommentReplyResponse = {
-    comment_reply_view: CommentReplyView;
-};

package/dist/types/GetPersonMentions.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSortType } from "./CommentSortType";
-/**
- * Get mentions for your user.
- */
-export type GetPersonMentions = {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-};

package/dist/types/GetPersonMentionsResponse.d.ts

@@ -1,7 +0,0 @@
-import type { PersonMentionView } from "./PersonMentionView";
-/**
- * The response of mentions for your user.
- */
-export type GetPersonMentionsResponse = {
-    mentions: Array<PersonMentionView>;
-};

package/dist/types/GetPrivateMessages.d.ts

@@ -1,10 +0,0 @@
-import type { PersonId } from "./PersonId";
-/**
- * Get your private messages.
- */
-export type GetPrivateMessages = {
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
-    creator_id?: PersonId;
-};

package/dist/types/GetReplies.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSortType } from "./CommentSortType";
-/**
- * Get comment replies.
- */
-export type GetReplies = {
-    sort?: CommentSortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
-};

package/dist/types/GetRepliesResponse.d.ts

@@ -1,7 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-/**
- * Fetches your replies.
- */
-export type GetRepliesResponse = {
-    replies: Array<CommentReplyView>;
-};

package/dist/types/ListCommentReports.d.ts

@@ -1,18 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommunityId } from "./CommunityId";
-/**
- * List comment reports.
- */
-export type ListCommentReports = {
-    comment_id?: CommentId;
-    page?: number;
-    limit?: number;
-    /**
-     * Only shows the unresolved reports
-     */
-    unresolved_only?: boolean;
-    /**
-     * if no community is given, it returns reports for all communities moderated by the auth user
-     */
-    community_id?: CommunityId;
-};