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

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 (221) hide show
  1. package/README.md +13 -4
  2. package/dist/http.d.ts +237 -430
  3. package/dist/http.js +1225 -411
  4. package/dist/index.d.ts +62 -20
  5. package/dist/other_types.d.ts +80 -16
  6. package/dist/types/AdminAllowInstance.d.ts +2 -1
  7. package/dist/types/AdminAllowInstanceId.d.ts +1 -0
  8. package/dist/types/AdminAllowInstanceView.d.ts +1 -1
  9. package/dist/types/AdminBlockInstance.d.ts +2 -1
  10. package/dist/types/AdminBlockInstanceId.d.ts +1 -0
  11. package/dist/types/AdminPurgeComment.d.ts +3 -2
  12. package/dist/types/AdminPurgeCommentId.d.ts +1 -0
  13. package/dist/types/AdminPurgeCommentId.js +3 -0
  14. package/dist/types/AdminPurgeCommunity.d.ts +3 -2
  15. package/dist/types/AdminPurgeCommunityId.d.ts +1 -0
  16. package/dist/types/AdminPurgeCommunityId.js +3 -0
  17. package/dist/types/AdminPurgePerson.d.ts +3 -2
  18. package/dist/types/AdminPurgePersonId.d.ts +1 -0
  19. package/dist/types/AdminPurgePersonId.js +3 -0
  20. package/dist/types/AdminPurgePost.d.ts +3 -2
  21. package/dist/types/AdminPurgePostId.d.ts +1 -0
  22. package/dist/types/AdminPurgePostId.js +3 -0
  23. package/dist/types/AuthenticateWithOauth.d.ts +1 -1
  24. package/dist/types/CommentReplyView.d.ts +5 -1
  25. package/dist/types/CommentReport.d.ts +1 -0
  26. package/dist/types/CommentReportView.d.ts +4 -1
  27. package/dist/types/CommentSlimView.d.ts +24 -0
  28. package/dist/types/CommentView.d.ts +5 -1
  29. package/dist/types/Community.d.ts +2 -2
  30. package/dist/types/CommunityAggregates.d.ts +2 -0
  31. package/dist/types/CommunityReport.d.ts +22 -0
  32. package/dist/types/CommunityReportId.d.ts +4 -0
  33. package/dist/types/CommunityReportId.js +3 -0
  34. package/dist/types/CommunityReportView.d.ts +16 -0
  35. package/dist/types/CommunitySortType.d.ts +1 -1
  36. package/dist/types/CommunityView.d.ts +1 -0
  37. package/dist/types/CreateCommentReport.d.ts +1 -0
  38. package/dist/types/CreateCommunity.d.ts +1 -1
  39. package/dist/types/CreatePost.d.ts +2 -0
  40. package/dist/types/CreatePostReport.d.ts +1 -0
  41. package/dist/types/CreateSite.d.ts +3 -5
  42. package/dist/types/DeleteImageParams.d.ts +3 -0
  43. package/dist/types/DeleteImageParams.js +3 -0
  44. package/dist/types/EditCommunity.d.ts +1 -9
  45. package/dist/types/EditPost.d.ts +2 -0
  46. package/dist/types/EditSite.d.ts +11 -18
  47. package/dist/types/FederationError.d.ts +2 -2
  48. package/dist/types/GetComments.d.ts +5 -1
  49. package/dist/types/GetCommentsSlimResponse.d.ts +7 -0
  50. package/dist/types/GetModlog.d.ts +27 -2
  51. package/dist/types/GetModlogResponse.d.ts +2 -34
  52. package/dist/types/GetPersonDetails.d.ts +0 -7
  53. package/dist/types/GetPersonDetailsResponse.d.ts +0 -4
  54. package/dist/types/GetPostResponse.d.ts +0 -2
  55. package/dist/types/GetPosts.d.ts +12 -0
  56. package/dist/types/GetRandomCommunity.d.ts +1 -0
  57. package/dist/types/GetReportCountResponse.d.ts +1 -5
  58. package/dist/types/GetReportCountResponse.js +1 -0
  59. package/dist/types/GetSiteResponse.d.ts +3 -10
  60. package/dist/types/GetUnreadCountResponse.d.ts +2 -4
  61. package/dist/types/ImageDetails.d.ts +1 -0
  62. package/dist/types/ImageGetParams.d.ts +4 -0
  63. package/dist/types/ImageGetParams.js +3 -0
  64. package/dist/types/ImageProxyParams.d.ts +5 -0
  65. package/dist/types/ImageProxyParams.js +3 -0
  66. package/dist/types/InboxCombinedPaginationCursor.d.ts +4 -0
  67. package/dist/types/InboxCombinedPaginationCursor.js +3 -0
  68. package/dist/types/InboxCombinedView.d.ts +13 -0
  69. package/dist/types/InboxDataType.d.ts +4 -0
  70. package/dist/types/InboxDataType.js +3 -0
  71. package/dist/types/LemmyErrorType.d.ts +5 -3
  72. package/dist/types/ListCommunities.d.ts +5 -0
  73. package/dist/types/ListInbox.d.ts +11 -0
  74. package/dist/types/ListInboxResponse.d.ts +7 -0
  75. package/dist/types/ListPersonContent.d.ts +18 -0
  76. package/dist/types/ListPersonContentResponse.d.ts +7 -0
  77. package/dist/types/ListPersonSaved.d.ts +10 -0
  78. package/dist/types/ListPersonSavedResponse.d.ts +7 -0
  79. package/dist/types/ListReports.d.ts +35 -0
  80. package/dist/types/ListReportsResponse.d.ts +7 -0
  81. package/dist/types/LocalImage.d.ts +0 -1
  82. package/dist/types/LocalSite.d.ts +9 -0
  83. package/dist/types/LocalUser.d.ts +13 -0
  84. package/dist/types/MarkPersonCommentMentionAsRead.d.ts +8 -0
  85. package/dist/types/MarkPersonPostMentionAsRead.d.ts +8 -0
  86. package/dist/types/ModAdd.d.ts +3 -2
  87. package/dist/types/ModAddCommunity.d.ts +3 -2
  88. package/dist/types/ModAddCommunityId.d.ts +1 -0
  89. package/dist/types/ModAddCommunityId.js +3 -0
  90. package/dist/types/ModAddCommunityView.d.ts +1 -1
  91. package/dist/types/ModAddId.d.ts +1 -0
  92. package/dist/types/ModAddId.js +3 -0
  93. package/dist/types/ModAddView.d.ts +1 -1
  94. package/dist/types/ModBan.d.ts +3 -2
  95. package/dist/types/ModBanFromCommunity.d.ts +3 -2
  96. package/dist/types/ModBanFromCommunityId.d.ts +1 -0
  97. package/dist/types/ModBanFromCommunityId.js +3 -0
  98. package/dist/types/ModBanFromCommunityView.d.ts +1 -1
  99. package/dist/types/ModBanId.d.ts +1 -0
  100. package/dist/types/ModBanId.js +3 -0
  101. package/dist/types/ModBanView.d.ts +1 -1
  102. package/dist/types/ModFeaturePost.d.ts +3 -2
  103. package/dist/types/ModFeaturePostId.d.ts +1 -0
  104. package/dist/types/ModFeaturePostId.js +3 -0
  105. package/dist/types/ModFeaturePostView.d.ts +1 -0
  106. package/dist/types/ModHideCommunity.d.ts +3 -2
  107. package/dist/types/ModHideCommunityId.d.ts +1 -0
  108. package/dist/types/ModHideCommunityId.js +3 -0
  109. package/dist/types/ModLockPost.d.ts +3 -2
  110. package/dist/types/ModLockPostId.d.ts +1 -0
  111. package/dist/types/ModLockPostId.js +3 -0
  112. package/dist/types/ModLockPostView.d.ts +1 -0
  113. package/dist/types/ModRemoveComment.d.ts +3 -2
  114. package/dist/types/ModRemoveCommentId.d.ts +1 -0
  115. package/dist/types/ModRemoveCommentId.js +3 -0
  116. package/dist/types/ModRemoveCommentView.d.ts +1 -1
  117. package/dist/types/ModRemoveCommunity.d.ts +3 -2
  118. package/dist/types/ModRemoveCommunityId.d.ts +1 -0
  119. package/dist/types/ModRemoveCommunityId.js +3 -0
  120. package/dist/types/ModRemovePost.d.ts +3 -2
  121. package/dist/types/ModRemovePostId.d.ts +1 -0
  122. package/dist/types/ModRemovePostId.js +3 -0
  123. package/dist/types/ModRemovePostView.d.ts +1 -0
  124. package/dist/types/ModTransferCommunity.d.ts +3 -2
  125. package/dist/types/ModTransferCommunityId.d.ts +1 -0
  126. package/dist/types/ModTransferCommunityId.js +3 -0
  127. package/dist/types/ModTransferCommunityView.d.ts +1 -1
  128. package/dist/types/ModlogCombinedPaginationCursor.d.ts +4 -0
  129. package/dist/types/ModlogCombinedPaginationCursor.js +3 -0
  130. package/dist/types/ModlogCombinedView.d.ts +52 -0
  131. package/dist/types/Person.d.ts +2 -2
  132. package/dist/types/PersonAggregates.d.ts +1 -0
  133. package/dist/types/{PersonMention.d.ts → PersonCommentMention.d.ts} +3 -3
  134. package/dist/types/PersonCommentMentionId.d.ts +4 -0
  135. package/dist/types/PersonCommentMentionId.js +3 -0
  136. package/dist/types/{PersonMentionView.d.ts → PersonCommentMentionView.d.ts} +9 -5
  137. package/dist/types/PersonCommentMentionView.js +2 -0
  138. package/dist/types/PersonContentCombinedPaginationCursor.d.ts +4 -0
  139. package/dist/types/PersonContentCombinedPaginationCursor.js +3 -0
  140. package/dist/types/PersonContentCombinedView.d.ts +7 -0
  141. package/dist/types/PersonContentCombinedView.js +2 -0
  142. package/dist/types/PersonContentType.d.ts +4 -0
  143. package/dist/types/PersonContentType.js +3 -0
  144. package/dist/types/PersonPostMention.d.ts +13 -0
  145. package/dist/types/PersonPostMention.js +2 -0
  146. package/dist/types/PersonPostMentionId.d.ts +4 -0
  147. package/dist/types/PersonPostMentionId.js +3 -0
  148. package/dist/types/PersonPostMentionView.d.ts +36 -0
  149. package/dist/types/PersonPostMentionView.js +2 -0
  150. package/dist/types/PersonSavedCombinedPaginationCursor.d.ts +4 -0
  151. package/dist/types/PersonSavedCombinedPaginationCursor.js +3 -0
  152. package/dist/types/PostReport.d.ts +1 -0
  153. package/dist/types/PostReportView.d.ts +4 -1
  154. package/dist/types/PostSortType.d.ts +1 -1
  155. package/dist/types/PostTags.d.ts +7 -0
  156. package/dist/types/PostTags.js +2 -0
  157. package/dist/types/PostView.d.ts +7 -1
  158. package/dist/types/PrivateMessage.d.ts +1 -0
  159. package/dist/types/ReportCombinedPaginationCursor.d.ts +4 -0
  160. package/dist/types/ReportCombinedPaginationCursor.js +3 -0
  161. package/dist/types/ReportCombinedView.d.ts +13 -0
  162. package/dist/types/ReportCombinedView.js +2 -0
  163. package/dist/types/ReportType.d.ts +4 -0
  164. package/dist/types/ReportType.js +3 -0
  165. package/dist/types/ResendVerificationEmail.d.ts +7 -0
  166. package/dist/types/ResendVerificationEmail.js +2 -0
  167. package/dist/types/SaveUserSettings.d.ts +9 -9
  168. package/dist/types/Search.d.ts +12 -7
  169. package/dist/types/SearchCombinedPaginationCursor.d.ts +4 -0
  170. package/dist/types/SearchCombinedPaginationCursor.js +3 -0
  171. package/dist/types/SearchCombinedView.d.ts +13 -0
  172. package/dist/types/SearchCombinedView.js +2 -0
  173. package/dist/types/SearchResponse.d.ts +2 -10
  174. package/dist/types/SearchSortType.d.ts +4 -0
  175. package/dist/types/SearchSortType.js +3 -0
  176. package/dist/types/Site.d.ts +2 -2
  177. package/dist/types/SiteResponse.d.ts +1 -1
  178. package/dist/types/SuccessResponse.d.ts +1 -1
  179. package/dist/types/Tag.d.ts +27 -0
  180. package/dist/types/Tag.js +2 -0
  181. package/dist/types/TagId.d.ts +4 -0
  182. package/dist/types/TagId.js +3 -0
  183. package/dist/types/UploadImageResponse.d.ts +4 -0
  184. package/dist/types/UploadImageResponse.js +3 -0
  185. package/package.json +9 -4
  186. package/dist/types/CommentReplyResponse.d.ts +0 -7
  187. package/dist/types/GetPersonMentions.d.ts +0 -10
  188. package/dist/types/GetPersonMentionsResponse.d.ts +0 -7
  189. package/dist/types/GetPrivateMessages.d.ts +0 -10
  190. package/dist/types/GetReplies.d.ts +0 -10
  191. package/dist/types/GetRepliesResponse.d.ts +0 -7
  192. package/dist/types/ListCommentReports.d.ts +0 -18
  193. package/dist/types/ListCommentReportsResponse.d.ts +0 -7
  194. package/dist/types/ListPostReports.d.ts +0 -18
  195. package/dist/types/ListPostReportsResponse.d.ts +0 -7
  196. package/dist/types/ListPrivateMessageReports.d.ts +0 -11
  197. package/dist/types/ListPrivateMessageReportsResponse.d.ts +0 -7
  198. package/dist/types/MarkPersonMentionAsRead.d.ts +0 -8
  199. package/dist/types/ModlogListParams.d.ts +0 -17
  200. package/dist/types/PersonMentionId.d.ts +0 -4
  201. package/dist/types/PersonMentionResponse.d.ts +0 -7
  202. package/dist/types/PrivateMessagesResponse.d.ts +0 -7
  203. /package/dist/types/{ListPrivateMessageReports.js → AdminAllowInstanceId.js} +0 -0
  204. /package/dist/types/{PersonMentionId.js → AdminBlockInstanceId.js} +0 -0
  205. /package/dist/types/{CommentReplyResponse.js → CommentSlimView.js} +0 -0
  206. /package/dist/types/{GetPersonMentions.js → CommunityReport.js} +0 -0
  207. /package/dist/types/{GetPersonMentionsResponse.js → CommunityReportView.js} +0 -0
  208. /package/dist/types/{GetPrivateMessages.js → GetCommentsSlimResponse.js} +0 -0
  209. /package/dist/types/{GetReplies.js → InboxCombinedView.js} +0 -0
  210. /package/dist/types/{GetRepliesResponse.js → ListInbox.js} +0 -0
  211. /package/dist/types/{ListCommentReports.js → ListInboxResponse.js} +0 -0
  212. /package/dist/types/{ListCommentReportsResponse.js → ListPersonContent.js} +0 -0
  213. /package/dist/types/{ListPostReports.js → ListPersonContentResponse.js} +0 -0
  214. /package/dist/types/{ListPostReportsResponse.js → ListPersonSaved.js} +0 -0
  215. /package/dist/types/{ListPrivateMessageReportsResponse.js → ListPersonSavedResponse.js} +0 -0
  216. /package/dist/types/{MarkPersonMentionAsRead.js → ListReports.js} +0 -0
  217. /package/dist/types/{ModlogListParams.js → ListReportsResponse.js} +0 -0
  218. /package/dist/types/{PersonMention.js → MarkPersonCommentMentionAsRead.js} +0 -0
  219. /package/dist/types/{PersonMentionResponse.js → MarkPersonPostMentionAsRead.js} +0 -0
  220. /package/dist/types/{PersonMentionView.js → ModlogCombinedView.js} +0 -0
  221. /package/dist/types/{PrivateMessagesResponse.js → PersonCommentMention.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/).