lemmy-js-client 0.20.0-modlog-combined.1 → 0.20.0-move-community-hidden.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/README.md +13 -4
  2. package/dist/http.d.ts +189 -466
  3. package/dist/http.js +1109 -418
  4. package/dist/index.d.ts +20 -18
  5. package/dist/other_types.d.ts +81 -0
  6. package/dist/types/Comment.d.ts +9 -0
  7. package/dist/types/CommentReplyView.d.ts +5 -3
  8. package/dist/types/CommentReport.d.ts +1 -0
  9. package/dist/types/CommentReportView.d.ts +4 -3
  10. package/dist/types/CommentSlimView.d.ts +22 -0
  11. package/dist/types/CommentView.d.ts +5 -3
  12. package/dist/types/Community.d.ts +24 -2
  13. package/dist/types/CommunityReportView.d.ts +0 -2
  14. package/dist/types/CommunitySortType.d.ts +1 -1
  15. package/dist/types/CommunityView.d.ts +1 -2
  16. package/dist/types/CommunityVisibility.d.ts +1 -1
  17. package/dist/types/CreateCommentReport.d.ts +1 -0
  18. package/dist/types/CreatePostReport.d.ts +1 -0
  19. package/dist/types/CreateSite.d.ts +2 -0
  20. package/dist/types/DeleteImageParams.d.ts +0 -1
  21. package/dist/types/EditSite.d.ts +13 -0
  22. package/dist/types/FederationError.d.ts +1 -1
  23. package/dist/types/GetComments.d.ts +5 -0
  24. package/dist/types/GetCommentsSlimResponse.d.ts +7 -0
  25. package/dist/types/GetModlog.d.ts +24 -0
  26. package/dist/types/GetPostResponse.d.ts +0 -2
  27. package/dist/types/GetPosts.d.ts +10 -0
  28. package/dist/types/GetRandomCommunity.d.ts +1 -0
  29. package/dist/types/GetSiteResponse.d.ts +2 -2
  30. package/dist/types/GetUnreadCountResponse.d.ts +2 -4
  31. package/dist/types/ImageDetails.d.ts +1 -0
  32. package/dist/types/InboxCombinedPaginationCursor.d.ts +4 -0
  33. package/dist/types/InboxCombinedView.d.ts +13 -0
  34. package/dist/types/InboxDataType.d.ts +4 -0
  35. package/dist/types/LemmyErrorType.d.ts +1 -1
  36. package/dist/types/ListCommunities.d.ts +5 -0
  37. package/dist/types/ListInbox.d.ts +11 -0
  38. package/dist/types/ListInboxResponse.d.ts +7 -0
  39. package/dist/types/ListReports.d.ts +18 -0
  40. package/dist/types/LocalImage.d.ts +0 -1
  41. package/dist/types/LocalSite.d.ts +33 -0
  42. package/dist/types/LocalUser.d.ts +17 -0
  43. package/dist/types/LocalUserView.d.ts +0 -4
  44. package/dist/types/MarkPersonCommentMentionAsRead.d.ts +8 -0
  45. package/dist/types/MarkPersonPostMentionAsRead.d.ts +8 -0
  46. package/dist/types/ModChangeCommunityVisibility.d.ts +12 -0
  47. package/dist/types/ModChangeCommunityVisibilityId.d.ts +1 -0
  48. package/dist/types/ModChangeCommunityVisibilityId.js +3 -0
  49. package/dist/types/ModChangeCommunityVisibilityView.d.ts +11 -0
  50. package/dist/types/Person.d.ts +4 -2
  51. package/dist/types/{PersonMention.d.ts → PersonCommentMention.d.ts} +3 -3
  52. package/dist/types/PersonCommentMentionId.d.ts +4 -0
  53. package/dist/types/PersonCommentMentionId.js +3 -0
  54. package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts} +9 -7
  55. package/dist/types/PersonContentType.d.ts +1 -1
  56. package/dist/types/PersonPostMention.d.ts +13 -0
  57. package/dist/types/PersonPostMentionId.d.ts +4 -0
  58. package/dist/types/PersonPostMentionId.js +3 -0
  59. package/dist/types/PersonPostMentionView.d.ts +34 -0
  60. package/dist/types/PersonSavedCombinedView.d.ts +7 -0
  61. package/dist/types/PersonView.d.ts +0 -2
  62. package/dist/types/Post.d.ts +10 -0
  63. package/dist/types/PostPaginationCursor.d.ts +7 -0
  64. package/dist/types/PostPaginationCursor.js +3 -0
  65. package/dist/types/PostReport.d.ts +1 -0
  66. package/dist/types/PostReportView.d.ts +4 -3
  67. package/dist/types/PostSortType.d.ts +1 -1
  68. package/dist/types/PostView.d.ts +5 -3
  69. package/dist/types/PrivateMessage.d.ts +1 -0
  70. package/dist/types/ReportType.d.ts +4 -0
  71. package/dist/types/ReportType.js +3 -0
  72. package/dist/types/ResendVerificationEmail.d.ts +7 -0
  73. package/dist/types/SaveUserSettings.d.ts +8 -0
  74. package/dist/types/Search.d.ts +12 -6
  75. package/dist/types/SearchCombinedPaginationCursor.d.ts +4 -0
  76. package/dist/types/SearchCombinedPaginationCursor.js +3 -0
  77. package/dist/types/SearchCombinedView.d.ts +13 -0
  78. package/dist/types/SearchResponse.d.ts +2 -10
  79. package/dist/types/SearchSortType.d.ts +4 -0
  80. package/dist/types/SearchSortType.js +3 -0
  81. package/dist/types/Site.d.ts +2 -2
  82. package/dist/types/SiteView.d.ts +0 -2
  83. package/dist/types/SuccessResponse.d.ts +1 -1
  84. package/dist/types/UploadImageResponse.d.ts +0 -1
  85. package/package.json +9 -4
  86. package/dist/types/CommentAggregates.d.ts +0 -17
  87. package/dist/types/CommentReplyResponse.d.ts +0 -7
  88. package/dist/types/CommunityAggregates.d.ts +0 -30
  89. package/dist/types/GetPersonMentions.d.ts +0 -10
  90. package/dist/types/GetPersonMentionsResponse.d.ts +0 -7
  91. package/dist/types/GetPrivateMessages.d.ts +0 -10
  92. package/dist/types/GetReplies.d.ts +0 -10
  93. package/dist/types/GetRepliesResponse.d.ts +0 -7
  94. package/dist/types/LocalUserVoteDisplayMode.d.ts +0 -9
  95. package/dist/types/MarkPersonMentionAsRead.d.ts +0 -8
  96. package/dist/types/PersonAggregates.d.ts +0 -9
  97. package/dist/types/PersonMentionId.d.ts +0 -4
  98. package/dist/types/PersonMentionResponse.d.ts +0 -7
  99. package/dist/types/PostAggregates.d.ts +0 -18
  100. package/dist/types/PrivateMessagesResponse.d.ts +0 -7
  101. package/dist/types/SiteAggregates.d.ts +0 -27
  102. /package/dist/types/{CommentAggregates.js → CommentSlimView.js} +0 -0
  103. /package/dist/types/{CommentReplyResponse.js → GetCommentsSlimResponse.js} +0 -0
  104. /package/dist/types/{LocalUserVoteDisplayMode.js → InboxCombinedPaginationCursor.js} +0 -0
  105. /package/dist/types/{CommunityAggregates.js → InboxCombinedView.js} +0 -0
  106. /package/dist/types/{PersonMentionId.js → InboxDataType.js} +0 -0
  107. /package/dist/types/{GetPersonMentions.js → ListInbox.js} +0 -0
  108. /package/dist/types/{GetPersonMentionsResponse.js → ListInboxResponse.js} +0 -0
  109. /package/dist/types/{GetPrivateMessages.js → MarkPersonCommentMentionAsRead.js} +0 -0
  110. /package/dist/types/{GetReplies.js → MarkPersonPostMentionAsRead.js} +0 -0
  111. /package/dist/types/{GetRepliesResponse.js → ModChangeCommunityVisibility.js} +0 -0
  112. /package/dist/types/{MarkPersonMentionAsRead.js → ModChangeCommunityVisibilityView.js} +0 -0
  113. /package/dist/types/{PersonAggregates.js → PersonCommentMention.js} +0 -0
  114. /package/dist/types/{PersonMention.js → PersonCommentMentionView.js} +0 -0
  115. /package/dist/types/{PersonMentionResponse.js → PersonPostMention.js} +0 -0
  116. /package/dist/types/{PersonMentionView.js → PersonPostMentionView.js} +0 -0
  117. /package/dist/types/{PostAggregates.js → PersonSavedCombinedView.js} +0 -0
  118. /package/dist/types/{PrivateMessagesResponse.js → ResendVerificationEmail.js} +0 -0
  119. /package/dist/types/{SiteAggregates.js → SearchCombinedView.js} +0 -0
@@ -26,9 +26,9 @@ export type Site = {
26
26
  */
27
27
  description?: string;
28
28
  /**
29
- * The federated actor_id.
29
+ * The federated ap_id.
30
30
  */
31
- actor_id: DbUrl;
31
+ ap_id: DbUrl;
32
32
  /**
33
33
  * The time the site was last refreshed.
34
34
  */
@@ -1,7 +1,6 @@
1
1
  import type { LocalSite } from "./LocalSite";
2
2
  import type { LocalSiteRateLimit } from "./LocalSiteRateLimit";
3
3
  import type { Site } from "./Site";
4
- import type { SiteAggregates } from "./SiteAggregates";
5
4
  /**
6
5
  * A site view.
7
6
  */
@@ -9,5 +8,4 @@ export type SiteView = {
9
8
  site: Site;
10
9
  local_site: LocalSite;
11
10
  local_site_rate_limit: LocalSiteRateLimit;
12
- counts: SiteAggregates;
13
11
  };
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Saves settings for your user.
2
+ * A response that completes successfully.
3
3
  */
4
4
  export type SuccessResponse = {
5
5
  success: boolean;
@@ -1,5 +1,4 @@
1
1
  export type UploadImageResponse = {
2
2
  image_url: string;
3
3
  filename: string;
4
- delete_token: string;
5
4
  };
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "lemmy-js-client",
3
3
  "description": "A javascript / typescript client for Lemmy",
4
- "version": "0.20.0-modlog-combined.1",
5
- "author": "Dessalines <tyhou13@gmx.com>",
4
+ "version": "0.20.0-move-community-hidden.2",
5
+ "author": "Dessalines",
6
6
  "license": "AGPL-3.0",
7
7
  "main": "./dist/index.js",
8
8
  "files": [
@@ -12,13 +12,17 @@
12
12
  "build": "tsc",
13
13
  "docs": "typedoc src/index.ts",
14
14
  "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
15
- "prepare": "pnpm run build && husky"
15
+ "prepare": "pnpm run build && husky",
16
+ "tsoa": "tsoa spec-and-routes && tsc && redocly build-docs tsoa_build/swagger.json"
16
17
  },
17
18
  "repository": {
18
19
  "type": "git",
19
20
  "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
20
21
  },
21
22
  "devDependencies": {
23
+ "@eslint/js": "^9.20.0",
24
+ "@redocly/cli": "^1.27.2",
25
+ "@types/joi": "^17.2.3",
22
26
  "@types/node": "^22.7.4",
23
27
  "@typescript-eslint/eslint-plugin": "^8.7.0",
24
28
  "@typescript-eslint/parser": "^8.7.0",
@@ -31,11 +35,12 @@
31
35
  "prettier-plugin-organize-imports": "^4.0.0",
32
36
  "prettier-plugin-packagejson": "^2.5.1",
33
37
  "sortpack": "^2.4.0",
38
+ "tsoa": "^6.6.0",
34
39
  "typedoc": "^0.27.0",
35
40
  "typescript": "^5.5.4",
36
41
  "typescript-eslint": "^8.7.0"
37
42
  },
38
- "packageManager": "pnpm@9.15.3",
43
+ "packageManager": "pnpm@10.6.1",
39
44
  "types": "./dist/index.d.ts",
40
45
  "lint-staged": {
41
46
  "*.{ts,tsx,js}": [
@@ -1,17 +0,0 @@
1
- import type { CommentId } from "./CommentId";
2
- /**
3
- * Aggregate data for a comment.
4
- */
5
- export type CommentAggregates = {
6
- comment_id: CommentId;
7
- score: number;
8
- upvotes: number;
9
- downvotes: number;
10
- published: string;
11
- /**
12
- * The total number of children in this comment branch.
13
- */
14
- child_count: number;
15
- report_count: number;
16
- unresolved_report_count: number;
17
- };
@@ -1,7 +0,0 @@
1
- import type { CommentReplyView } from "./CommentReplyView";
2
- /**
3
- * The response for a comment reply action.
4
- */
5
- export type CommentReplyResponse = {
6
- comment_reply_view: CommentReplyView;
7
- };
@@ -1,30 +0,0 @@
1
- import type { CommunityId } from "./CommunityId";
2
- /**
3
- * Aggregate data for a community.
4
- */
5
- export type CommunityAggregates = {
6
- community_id: CommunityId;
7
- subscribers: number;
8
- posts: number;
9
- comments: number;
10
- published: string;
11
- /**
12
- * The number of users with any activity in the last day.
13
- */
14
- users_active_day: number;
15
- /**
16
- * The number of users with any activity in the last week.
17
- */
18
- users_active_week: number;
19
- /**
20
- * The number of users with any activity in the last month.
21
- */
22
- users_active_month: number;
23
- /**
24
- * The number of users with any activity in the last year.
25
- */
26
- users_active_half_year: number;
27
- subscribers_local: number;
28
- report_count: number;
29
- unresolved_report_count: number;
30
- };
@@ -1,10 +0,0 @@
1
- import type { CommentSortType } from "./CommentSortType";
2
- /**
3
- * Get mentions for your user.
4
- */
5
- export type GetPersonMentions = {
6
- sort?: CommentSortType;
7
- page?: number;
8
- limit?: number;
9
- unread_only?: boolean;
10
- };
@@ -1,7 +0,0 @@
1
- import type { PersonMentionView } from "./PersonMentionView";
2
- /**
3
- * The response of mentions for your user.
4
- */
5
- export type GetPersonMentionsResponse = {
6
- mentions: Array<PersonMentionView>;
7
- };
@@ -1,10 +0,0 @@
1
- import type { PersonId } from "./PersonId";
2
- /**
3
- * Get your private messages.
4
- */
5
- export type GetPrivateMessages = {
6
- unread_only?: boolean;
7
- page?: number;
8
- limit?: number;
9
- creator_id?: PersonId;
10
- };
@@ -1,10 +0,0 @@
1
- import type { CommentSortType } from "./CommentSortType";
2
- /**
3
- * Get comment replies.
4
- */
5
- export type GetReplies = {
6
- sort?: CommentSortType;
7
- page?: number;
8
- limit?: number;
9
- unread_only?: boolean;
10
- };
@@ -1,7 +0,0 @@
1
- import type { CommentReplyView } from "./CommentReplyView";
2
- /**
3
- * Fetches your replies.
4
- */
5
- export type GetRepliesResponse = {
6
- replies: Array<CommentReplyView>;
7
- };
@@ -1,9 +0,0 @@
1
- /**
2
- * The vote display settings for your user.
3
- */
4
- export type LocalUserVoteDisplayMode = {
5
- score: boolean;
6
- upvotes: boolean;
7
- downvotes: boolean;
8
- upvote_percentage: boolean;
9
- };
@@ -1,8 +0,0 @@
1
- import type { PersonMentionId } from "./PersonMentionId";
2
- /**
3
- * Mark a person mention as read.
4
- */
5
- export type MarkPersonMentionAsRead = {
6
- person_mention_id: PersonMentionId;
7
- read: boolean;
8
- };
@@ -1,9 +0,0 @@
1
- import type { PersonId } from "./PersonId";
2
- /**
3
- * Aggregate data for a person.
4
- */
5
- export type PersonAggregates = {
6
- person_id: PersonId;
7
- post_count: number;
8
- comment_count: number;
9
- };
@@ -1,4 +0,0 @@
1
- /**
2
- * The person mention id.
3
- */
4
- export type PersonMentionId = number;
@@ -1,7 +0,0 @@
1
- import type { PersonMentionView } from "./PersonMentionView";
2
- /**
3
- * The response for a person mention action.
4
- */
5
- export type PersonMentionResponse = {
6
- person_mention_view: PersonMentionView;
7
- };
@@ -1,18 +0,0 @@
1
- import type { PostId } from "./PostId";
2
- /**
3
- * Aggregate data for a post.
4
- */
5
- export type PostAggregates = {
6
- post_id: PostId;
7
- comments: number;
8
- score: number;
9
- upvotes: number;
10
- downvotes: number;
11
- published: string;
12
- /**
13
- * The time of the newest comment in the post.
14
- */
15
- newest_comment_time: string;
16
- report_count: number;
17
- unresolved_report_count: number;
18
- };
@@ -1,7 +0,0 @@
1
- import type { PrivateMessageView } from "./PrivateMessageView";
2
- /**
3
- * The private messages response.
4
- */
5
- export type PrivateMessagesResponse = {
6
- private_messages: Array<PrivateMessageView>;
7
- };
@@ -1,27 +0,0 @@
1
- import type { SiteId } from "./SiteId";
2
- /**
3
- * Aggregate data for a site.
4
- */
5
- export type SiteAggregates = {
6
- site_id: SiteId;
7
- users: number;
8
- posts: number;
9
- comments: number;
10
- communities: number;
11
- /**
12
- * The number of users with any activity in the last day.
13
- */
14
- users_active_day: number;
15
- /**
16
- * The number of users with any activity in the last week.
17
- */
18
- users_active_week: number;
19
- /**
20
- * The number of users with any activity in the last month.
21
- */
22
- users_active_month: number;
23
- /**
24
- * The number of users with any activity in the last half year.
25
- */
26
- users_active_half_year: number;
27
- };