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

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 (134) 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 +23 -25
  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 -6
  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 +3 -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 +26 -2
  26. package/dist/types/GetModlogResponse.d.ts +5 -0
  27. package/dist/types/GetPostResponse.d.ts +0 -2
  28. package/dist/types/GetPosts.d.ts +12 -2
  29. package/dist/types/GetPostsResponse.d.ts +2 -2
  30. package/dist/types/GetRandomCommunity.d.ts +1 -0
  31. package/dist/types/GetSiteResponse.d.ts +2 -2
  32. package/dist/types/GetUnreadCountResponse.d.ts +2 -4
  33. package/dist/types/ImageDetails.d.ts +1 -0
  34. package/dist/types/InboxCombinedView.d.ts +13 -0
  35. package/dist/types/InboxDataType.d.ts +4 -0
  36. package/dist/types/LemmyErrorType.d.ts +5 -5
  37. package/dist/types/ListCommunities.d.ts +5 -0
  38. package/dist/types/ListInbox.d.ts +11 -0
  39. package/dist/types/ListInboxResponse.d.ts +12 -0
  40. package/dist/types/ListPersonContent.d.ts +2 -2
  41. package/dist/types/ListPersonContentResponse.d.ts +5 -0
  42. package/dist/types/ListPersonSaved.d.ts +2 -2
  43. package/dist/types/ListPersonSavedResponse.d.ts +7 -2
  44. package/dist/types/ListReports.d.ts +20 -2
  45. package/dist/types/ListReportsResponse.d.ts +5 -0
  46. package/dist/types/LocalImage.d.ts +0 -1
  47. package/dist/types/LocalSite.d.ts +33 -0
  48. package/dist/types/LocalUser.d.ts +17 -0
  49. package/dist/types/LocalUserView.d.ts +0 -4
  50. package/dist/types/MarkPersonCommentMentionAsRead.d.ts +8 -0
  51. package/dist/types/MarkPersonPostMentionAsRead.d.ts +8 -0
  52. package/dist/types/ModChangeCommunityVisibility.d.ts +12 -0
  53. package/dist/types/ModChangeCommunityVisibilityId.d.ts +1 -0
  54. package/dist/types/ModChangeCommunityVisibilityView.d.ts +11 -0
  55. package/dist/types/ModlogActionType.d.ts +1 -1
  56. package/dist/types/ModlogCombinedView.d.ts +3 -3
  57. package/dist/types/PaginationCursor.d.ts +1 -4
  58. package/dist/types/Person.d.ts +4 -2
  59. package/dist/types/{PersonMention.d.ts → PersonCommentMention.d.ts} +3 -3
  60. package/dist/types/PersonCommentMentionId.d.ts +4 -0
  61. package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts} +9 -7
  62. package/dist/types/PersonContentType.d.ts +1 -1
  63. package/dist/types/PersonPostMention.d.ts +13 -0
  64. package/dist/types/PersonPostMentionId.d.ts +4 -0
  65. package/dist/types/PersonPostMentionView.d.ts +34 -0
  66. package/dist/types/PersonSavedCombinedView.d.ts +7 -0
  67. package/dist/types/PersonView.d.ts +0 -2
  68. package/dist/types/Post.d.ts +10 -0
  69. package/dist/types/PostPaginationCursor.d.ts +7 -0
  70. package/dist/types/PostReport.d.ts +1 -0
  71. package/dist/types/PostReportView.d.ts +4 -3
  72. package/dist/types/PostSortType.d.ts +1 -1
  73. package/dist/types/PostView.d.ts +5 -3
  74. package/dist/types/PrivateMessage.d.ts +1 -0
  75. package/dist/types/ReportType.d.ts +4 -0
  76. package/dist/types/ResendVerificationEmail.d.ts +7 -0
  77. package/dist/types/SaveUserSettings.d.ts +8 -0
  78. package/dist/types/Search.d.ts +12 -6
  79. package/dist/types/SearchCombinedView.d.ts +13 -0
  80. package/dist/types/SearchResponse.d.ts +7 -10
  81. package/dist/types/SearchSortType.d.ts +4 -0
  82. package/dist/types/Site.d.ts +2 -2
  83. package/dist/types/SiteView.d.ts +0 -2
  84. package/dist/types/SuccessResponse.d.ts +1 -1
  85. package/dist/types/UploadImageResponse.d.ts +0 -1
  86. package/package.json +9 -4
  87. package/dist/types/CommentAggregates.d.ts +0 -17
  88. package/dist/types/CommentReplyResponse.d.ts +0 -7
  89. package/dist/types/CommunityAggregates.d.ts +0 -30
  90. package/dist/types/GetPersonMentions.d.ts +0 -10
  91. package/dist/types/GetPersonMentionsResponse.d.ts +0 -7
  92. package/dist/types/GetPrivateMessages.d.ts +0 -10
  93. package/dist/types/GetReplies.d.ts +0 -10
  94. package/dist/types/GetRepliesResponse.d.ts +0 -7
  95. package/dist/types/LocalUserVoteDisplayMode.d.ts +0 -9
  96. package/dist/types/MarkPersonMentionAsRead.d.ts +0 -8
  97. package/dist/types/ModHideCommunity.d.ts +0 -14
  98. package/dist/types/ModHideCommunityId.d.ts +0 -1
  99. package/dist/types/ModHideCommunityView.d.ts +0 -11
  100. package/dist/types/ModlogCombinedPaginationCursor.d.ts +0 -4
  101. package/dist/types/PersonAggregates.d.ts +0 -9
  102. package/dist/types/PersonContentCombinedPaginationCursor.d.ts +0 -4
  103. package/dist/types/PersonMentionId.d.ts +0 -4
  104. package/dist/types/PersonMentionResponse.d.ts +0 -7
  105. package/dist/types/PersonSavedCombinedPaginationCursor.d.ts +0 -4
  106. package/dist/types/PostAggregates.d.ts +0 -18
  107. package/dist/types/PrivateMessagesResponse.d.ts +0 -7
  108. package/dist/types/PrivateMessagesResponse.js +0 -2
  109. package/dist/types/ReportCombinedPaginationCursor.d.ts +0 -4
  110. package/dist/types/SiteAggregates.d.ts +0 -27
  111. package/dist/types/SiteAggregates.js +0 -2
  112. /package/dist/types/{CommentAggregates.js → CommentSlimView.js} +0 -0
  113. /package/dist/types/{CommentReplyResponse.js → GetCommentsSlimResponse.js} +0 -0
  114. /package/dist/types/{CommunityAggregates.js → InboxCombinedView.js} +0 -0
  115. /package/dist/types/{LocalUserVoteDisplayMode.js → InboxDataType.js} +0 -0
  116. /package/dist/types/{GetPersonMentions.js → ListInbox.js} +0 -0
  117. /package/dist/types/{GetPersonMentionsResponse.js → ListInboxResponse.js} +0 -0
  118. /package/dist/types/{GetPrivateMessages.js → MarkPersonCommentMentionAsRead.js} +0 -0
  119. /package/dist/types/{GetReplies.js → MarkPersonPostMentionAsRead.js} +0 -0
  120. /package/dist/types/{GetRepliesResponse.js → ModChangeCommunityVisibility.js} +0 -0
  121. /package/dist/types/{ModHideCommunityId.js → ModChangeCommunityVisibilityId.js} +0 -0
  122. /package/dist/types/{MarkPersonMentionAsRead.js → ModChangeCommunityVisibilityView.js} +0 -0
  123. /package/dist/types/{ModHideCommunity.js → PersonCommentMention.js} +0 -0
  124. /package/dist/types/{ModlogCombinedPaginationCursor.js → PersonCommentMentionId.js} +0 -0
  125. /package/dist/types/{ModHideCommunityView.js → PersonCommentMentionView.js} +0 -0
  126. /package/dist/types/{PersonAggregates.js → PersonPostMention.js} +0 -0
  127. /package/dist/types/{PersonContentCombinedPaginationCursor.js → PersonPostMentionId.js} +0 -0
  128. /package/dist/types/{PersonMention.js → PersonPostMentionView.js} +0 -0
  129. /package/dist/types/{PersonMentionResponse.js → PersonSavedCombinedView.js} +0 -0
  130. /package/dist/types/{PersonMentionId.js → PostPaginationCursor.js} +0 -0
  131. /package/dist/types/{PersonSavedCombinedPaginationCursor.js → ReportType.js} +0 -0
  132. /package/dist/types/{PersonMentionView.js → ResendVerificationEmail.js} +0 -0
  133. /package/dist/types/{PostAggregates.js → SearchCombinedView.js} +0 -0
  134. /package/dist/types/{ReportCombinedPaginationCursor.js → SearchSortType.js} +0 -0
package/README.md CHANGED
@@ -19,7 +19,7 @@ A javascript / typescript http client and type system for [Lemmy](https://github
19
19
 
20
20
  ### HTTP Client
21
21
 
22
- [LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
22
+ [LemmyHttp docs](https://join-lemmy.org/docs/contributors/04-api.html)
23
23
 
24
24
  ```ts
25
25
  import { LemmyHttp, Login } from "lemmy-js-client";
@@ -50,6 +50,15 @@ const posts = await client.getPosts(getPostsForm);
50
50
 
51
51
  Use `pnpm add` to develop and test changes locally:
52
52
 
53
- ```
54
- pnpm add path/to/lemmy-js-client
55
- ```
53
+ `pnpm add path/to/lemmy-js-client`
54
+
55
+ ## OpenAPI
56
+
57
+ To generate OpenAPI docs, run `pnpm tsoa`
58
+
59
+ This creates two files:
60
+
61
+ - `redoc-static.html` - A static html rendering of the OpenAPI docs.
62
+ - `tsoa_build/swagger.json` - An OpenAPI / Swagger json file.
63
+
64
+ To contribute, check out the [tsoa docs](https://tsoa-community.github.io/docs/).