lemmy-js-client 1.0.0-api-updates-6.1 → 1.0.0-beta.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 (132) hide show
  1. package/README.md +30 -4
  2. package/dist/http.d.ts +218 -195
  3. package/dist/http.js +348 -308
  4. package/dist/index.d.ts +32 -27
  5. package/dist/index.js +1 -0
  6. package/dist/other_types.d.ts +5 -5
  7. package/dist/request_state.d.ts +27 -0
  8. package/dist/request_state.js +15 -0
  9. package/dist/types/AdminListUsers.d.ts +2 -0
  10. package/dist/types/{OAuthProvider.d.ts → AdminOAuthProvider.d.ts} +1 -1
  11. package/dist/types/AllLemmyErrors.js +1 -4
  12. package/dist/types/{PasswordChangeAfterReset.d.ts → ChangePasswordAfterReset.d.ts} +1 -1
  13. package/dist/types/CommentView.d.ts +2 -2
  14. package/dist/types/Community.d.ts +3 -2
  15. package/dist/types/CommunityReport.d.ts +1 -1
  16. package/dist/types/{Tag.d.ts → CommunityTag.d.ts} +6 -4
  17. package/dist/types/CommunityTagId.d.ts +4 -0
  18. package/dist/types/CommunityTagsView.d.ts +5 -0
  19. package/dist/types/CommunityView.d.ts +2 -2
  20. package/dist/types/CreateCommentReport.d.ts +4 -0
  21. package/dist/types/CreateCommentWarning.d.ts +8 -0
  22. package/dist/types/CreateCommunity.d.ts +2 -2
  23. package/dist/types/CreateCommunityTag.d.ts +3 -1
  24. package/dist/types/CreateMultiCommunity.d.ts +2 -1
  25. package/dist/types/CreatePost.d.ts +2 -2
  26. package/dist/types/CreatePostReport.d.ts +4 -0
  27. package/dist/types/CreatePostWarning.d.ts +8 -0
  28. package/dist/types/CreateSite.d.ts +18 -7
  29. package/dist/types/DeleteCommunityTag.d.ts +3 -2
  30. package/dist/types/EditCommunity.d.ts +2 -2
  31. package/dist/types/{UpdateCommunityNotifications.d.ts → EditCommunityNotifications.d.ts} +1 -1
  32. package/dist/types/EditCommunityTag.d.ts +11 -0
  33. package/dist/types/{UpdateMultiCommunity.d.ts → EditMultiCommunity.d.ts} +3 -2
  34. package/dist/types/EditPost.d.ts +2 -2
  35. package/dist/types/{UpdatePostNotifications.d.ts → EditPostNotifications.d.ts} +1 -1
  36. package/dist/types/EditSite.d.ts +31 -14
  37. package/dist/types/{UpdateTagline.d.ts → EditTagline.d.ts} +1 -1
  38. package/dist/types/{UpdateTotp.d.ts → EditTotp.d.ts} +1 -1
  39. package/dist/types/EditTotpResponse.d.ts +3 -0
  40. package/dist/types/GetComments.d.ts +4 -0
  41. package/dist/types/GetModlog.d.ts +11 -2
  42. package/dist/types/GetPosts.d.ts +6 -0
  43. package/dist/types/GetSiteResponse.d.ts +3 -3
  44. package/dist/types/ImageMode.d.ts +4 -0
  45. package/dist/types/LemmyErrorType.d.ts +4 -15
  46. package/dist/types/LemmyErrorType.js +1 -0
  47. package/dist/types/ListCommunities.d.ts +4 -0
  48. package/dist/types/ListMultiCommunities.d.ts +2 -0
  49. package/dist/types/ListNotifications.d.ts +4 -2
  50. package/dist/types/ListPersonContent.d.ts +3 -0
  51. package/dist/types/ListPersons.d.ts +11 -0
  52. package/dist/types/LocalSite.d.ts +32 -12
  53. package/dist/types/LocalUser.d.ts +2 -2
  54. package/dist/types/LocalUserSortType.d.ts +4 -0
  55. package/dist/types/ModEditPost.d.ts +2 -2
  56. package/dist/types/Modlog.d.ts +1 -0
  57. package/dist/types/ModlogKind.d.ts +1 -1
  58. package/dist/types/ModlogKindFilter.d.ts +5 -0
  59. package/dist/types/MultiCommunity.d.ts +9 -1
  60. package/dist/types/NodeInfo.d.ts +20 -0
  61. package/dist/types/NodeInfoServices.d.ts +4 -0
  62. package/dist/types/NodeInfoSoftware.d.ts +6 -0
  63. package/dist/types/NodeInfoUsage.d.ts +6 -0
  64. package/dist/types/NodeInfoUsers.d.ts +5 -0
  65. package/dist/types/Notification.d.ts +1 -0
  66. package/dist/types/NotificationTypeFilter.d.ts +5 -0
  67. package/dist/types/PagedResponse.d.ts +1 -1
  68. package/dist/types/Person.d.ts +1 -0
  69. package/dist/types/PersonListingType.d.ts +4 -0
  70. package/dist/types/PersonSortType.d.ts +4 -0
  71. package/dist/types/{PersonLikedCombinedView.d.ts → PostCommentCombinedView.d.ts} +1 -1
  72. package/dist/types/PostView.d.ts +2 -2
  73. package/dist/types/PrivateMessage.d.ts +1 -0
  74. package/dist/types/PublicOAuthProvider.d.ts +27 -2
  75. package/dist/types/RemoveComment.d.ts +5 -0
  76. package/dist/types/RemovePost.d.ts +5 -0
  77. package/dist/types/{PasswordReset.d.ts → ResetPassword.d.ts} +1 -1
  78. package/dist/types/ResetPassword.js +2 -0
  79. package/dist/types/{SearchCombinedView.d.ts → ResolveObjectView.d.ts} +3 -3
  80. package/dist/types/ResolveObjectView.js +2 -0
  81. package/dist/types/SaveUserSettings.d.ts +2 -2
  82. package/dist/types/Search.d.ts +3 -7
  83. package/dist/types/SearchResponse.d.ts +14 -13
  84. package/dist/types/Site.d.ts +2 -3
  85. package/dist/types/TagColor.d.ts +4 -0
  86. package/dist/types/TagColor.js +3 -0
  87. package/dist/types/UnreadCountsResponse.d.ts +11 -0
  88. package/dist/types/UnreadCountsResponse.js +3 -0
  89. package/package.json +7 -7
  90. package/dist/types/GetCommunityPendingFollowsCountResponse.d.ts +0 -3
  91. package/dist/types/GetReportCount.d.ts +0 -7
  92. package/dist/types/GetReportCountResponse.d.ts +0 -6
  93. package/dist/types/GetUnreadCountResponse.d.ts +0 -6
  94. package/dist/types/GetUnreadRegistrationApplicationCountResponse.d.ts +0 -6
  95. package/dist/types/InstanceWithFederationState.d.ts +0 -24
  96. package/dist/types/NotificationDataType.d.ts +0 -4
  97. package/dist/types/PersonContentCombinedView.d.ts +0 -7
  98. package/dist/types/PersonSavedCombinedView.d.ts +0 -7
  99. package/dist/types/ReadableFederationState.d.ts +0 -22
  100. package/dist/types/SearchSortType.d.ts +0 -4
  101. package/dist/types/TagId.d.ts +0 -4
  102. package/dist/types/TagsView.d.ts +0 -5
  103. package/dist/types/UntranslatedError.d.ts +0 -14
  104. package/dist/types/UpdateCommunityTag.d.ts +0 -9
  105. package/dist/types/UpdateTotpResponse.d.ts +0 -3
  106. /package/dist/types/{GetReportCount.js → AdminOAuthProvider.js} +0 -0
  107. /package/dist/types/{InstanceWithFederationState.js → ChangePasswordAfterReset.js} +0 -0
  108. /package/dist/types/{OAuthProvider.js → CommunityTag.js} +0 -0
  109. /package/dist/types/{GetCommunityPendingFollowsCountResponse.js → CommunityTagId.js} +0 -0
  110. /package/dist/types/{PasswordChangeAfterReset.js → CommunityTagsView.js} +0 -0
  111. /package/dist/types/{PasswordReset.js → CreateCommentWarning.js} +0 -0
  112. /package/dist/types/{PersonContentCombinedView.js → CreatePostWarning.js} +0 -0
  113. /package/dist/types/{PersonLikedCombinedView.js → EditCommunityNotifications.js} +0 -0
  114. /package/dist/types/{PersonSavedCombinedView.js → EditCommunityTag.js} +0 -0
  115. /package/dist/types/{ReadableFederationState.js → EditMultiCommunity.js} +0 -0
  116. /package/dist/types/{SearchCombinedView.js → EditPostNotifications.js} +0 -0
  117. /package/dist/types/{Tag.js → EditTagline.js} +0 -0
  118. /package/dist/types/{GetReportCountResponse.js → EditTotp.js} +0 -0
  119. /package/dist/types/{GetUnreadCountResponse.js → EditTotpResponse.js} +0 -0
  120. /package/dist/types/{GetUnreadRegistrationApplicationCountResponse.js → ImageMode.js} +0 -0
  121. /package/dist/types/{TagsView.js → ListPersons.js} +0 -0
  122. /package/dist/types/{NotificationDataType.js → LocalUserSortType.js} +0 -0
  123. /package/dist/types/{UpdateCommunityNotifications.js → ModlogKindFilter.js} +0 -0
  124. /package/dist/types/{UpdateCommunityTag.js → NodeInfo.js} +0 -0
  125. /package/dist/types/{SearchSortType.js → NodeInfoServices.js} +0 -0
  126. /package/dist/types/{TagId.js → NodeInfoSoftware.js} +0 -0
  127. /package/dist/types/{UpdateMultiCommunity.js → NodeInfoUsage.js} +0 -0
  128. /package/dist/types/{UntranslatedError.js → NodeInfoUsers.js} +0 -0
  129. /package/dist/types/{UpdatePostNotifications.js → NotificationTypeFilter.js} +0 -0
  130. /package/dist/types/{UpdateTotp.js → PersonListingType.js} +0 -0
  131. /package/dist/types/{UpdateTotpResponse.js → PersonSortType.js} +0 -0
  132. /package/dist/types/{UpdateTagline.js → PostCommentCombinedView.js} +0 -0
package/README.md CHANGED
@@ -26,7 +26,8 @@ import { LemmyHttp, Login } from "lemmy-js-client";
26
26
 
27
27
  // Build the client
28
28
  const baseUrl = "https://lemmy.ml";
29
- const client: LemmyHttp = new LemmyHttp(baseUrl);
29
+ const headers = {["x-real-ip": ...]};
30
+ const client: LemmyHttp = new LemmyHttp(baseUrl, { headers });
30
31
 
31
32
  // Build the login form
32
33
  const loginForm: Login = {
@@ -35,15 +36,40 @@ const loginForm: Login = {
35
36
  };
36
37
 
37
38
  // Login and set the client headers with your jwt
38
- const { jwt } = await client.login(loginForm);
39
- client.setHeaders({ Authorization: `Bearer ${jwt}` });
39
+ const loginRes = await client.login(loginForm);
40
+
41
+ // Make sure its successful
42
+ if (loginRes.state === "success") {
43
+ const jwt = login.data.jwt;
44
+ client.setHeaders({ Authorization: `Bearer ${jwt}` });
45
+ } else if (loginRes.state === "failed") {
46
+ const err = login.err;
47
+ }
40
48
 
41
49
  // Fetch top posts for the day
42
50
  const getPostsForm: GetPosts = {
43
51
  sort: "TopDay",
44
52
  type_: "Local",
45
53
  };
46
- const posts = await client.getPosts(getPostsForm);
54
+ const postsRes = await client.getPosts(getPostsForm);
55
+
56
+ // Handle the different request states
57
+ switch (postsRes.state) {
58
+ case "empty": {
59
+ break;
60
+ }
61
+ case "loading": {
62
+ break;
63
+ }
64
+ case "failed": {
65
+ const err = postsRes.err;
66
+ break;
67
+ }
68
+ case "success": {
69
+ const data = postsRes.data;
70
+ break;
71
+ }
72
+ }
47
73
  ```
48
74
 
49
75
  ## Development