sidechat.js 2.2.0 → 2.2.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 (40) hide show
  1. package/README.md +8 -3
  2. package/dist/classes/SidechatAPIClient.d.ts +11 -1
  3. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  4. package/dist/index.cjs +38 -1
  5. package/dist/index.mjs +38 -1
  6. package/docs/sidechat.js/2.2.0/index.html +1 -1
  7. package/docs/sidechat.js/2.2.1/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.2.1/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/2.2.1/classes_SidechatAPIClient.js.html +688 -0
  10. package/docs/sidechat.js/2.2.1/classes_SidechatAPIError.js.html +16 -0
  11. package/docs/sidechat.js/2.2.1/data/search.json +1 -0
  12. package/docs/sidechat.js/2.2.1/fonts/Inconsolata-Regular.ttf +0 -0
  13. package/docs/sidechat.js/2.2.1/fonts/OpenSans-Regular.ttf +0 -0
  14. package/docs/sidechat.js/2.2.1/fonts/WorkSans-Bold.ttf +0 -0
  15. package/docs/sidechat.js/2.2.1/global.html +3 -0
  16. package/docs/sidechat.js/2.2.1/index.html +4 -0
  17. package/docs/sidechat.js/2.2.1/scripts/core.js +702 -0
  18. package/docs/sidechat.js/2.2.1/scripts/core.min.js +23 -0
  19. package/docs/sidechat.js/2.2.1/scripts/resize.js +90 -0
  20. package/docs/sidechat.js/2.2.1/scripts/search.js +265 -0
  21. package/docs/sidechat.js/2.2.1/scripts/search.min.js +6 -0
  22. package/docs/sidechat.js/2.2.1/scripts/third-party/Apache-License-2.0.txt +202 -0
  23. package/docs/sidechat.js/2.2.1/scripts/third-party/fuse.js +9 -0
  24. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num-original.js +369 -0
  25. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-line-num.js +1 -0
  26. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs-original.js +5171 -0
  27. package/docs/sidechat.js/2.2.1/scripts/third-party/hljs.js +1 -0
  28. package/docs/sidechat.js/2.2.1/scripts/third-party/popper.js +5 -0
  29. package/docs/sidechat.js/2.2.1/scripts/third-party/tippy.js +1 -0
  30. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.js +672 -0
  31. package/docs/sidechat.js/2.2.1/scripts/third-party/tocbot.min.js +1 -0
  32. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-base.css +975 -0
  33. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-dark.css +407 -0
  34. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme-light.css +388 -0
  35. package/docs/sidechat.js/2.2.1/styles/clean-jsdoc-theme.min.css +1 -0
  36. package/docs/sidechat.js/2.2.1/tutorial-Authentication.html +14 -0
  37. package/docs/sidechat.js/2.2.1/tutorial-Email Registration.html +6 -0
  38. package/docs/sidechat.js/2.2.1/types_SidechatTypes.js.html +134 -0
  39. package/package.json +1 -1
  40. package/src/classes/SidechatAPIClient.js +38 -1
@@ -0,0 +1,688 @@
1
+ <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: classes/SidechatAPIClient.js</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(baseURL=(baseURL="https://micahlindley.com/sidechat.js/").replace(/https?:\/\//i,"")).substr(baseURL.indexOf("/"))</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">classes_SidechatAPIClient.js</h1></header><article><pre class="prettyprint source lang-js"><code>import "../types/SidechatTypes.js";
4
+ import SidechatAPIError from "../classes/SidechatAPIError.js";
5
+
6
+ /**
7
+ * API client class for making requests to Sidechat's private API. You'll need to [authenticate]{@tutorial Authentication} before using most of the methods.
8
+ * @class
9
+ * @since 2.0.0-alpha.0
10
+ */
11
+ class SidechatAPIClient {
12
+ /**
13
+ * User bearer token
14
+ * @type {SidechatAuthToken}
15
+ * */
16
+ userToken;
17
+ /**
18
+ * Default headers for every API request
19
+ * @type {Object}
20
+ * @static
21
+ * @constant
22
+ */
23
+ defaultHeaders = {
24
+ Accept: "application/json",
25
+ "Content-Type": "application/json",
26
+ };
27
+
28
+ /**
29
+ * Create a new instance of the API client
30
+ * @param {SidechatAuthToken} [token] - user bearer token
31
+ */
32
+ constructor(token = "") {
33
+ if (token) {
34
+ this.userToken = token;
35
+ }
36
+ }
37
+
38
+ /**
39
+ * Manually set the currently signed in user's token. Generally try to avoid this and instead either pass a token to the constructor or login automatically through the auth functions
40
+ * @method
41
+ * @param {SidechatAuthToken} token - user bearer token
42
+ */
43
+ setToken = (token) => {
44
+ this.userToken = token;
45
+ };
46
+
47
+ /**
48
+ * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
49
+ * @method
50
+ * @since 1.0.0
51
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
52
+ */
53
+ loginViaSMS = async (phoneNumber) => {
54
+ try {
55
+ const res = await fetch(`https://api.sidechat.lol/v1/login_register`, {
56
+ method: "POST",
57
+ headers: this.defaultHeaders,
58
+ body: JSON.stringify({
59
+ phone_number: `+1${phoneNumber}`,
60
+ version: 3,
61
+ }),
62
+ });
63
+ const json = await res.json();
64
+ return json;
65
+ } catch (err) {
66
+ console.error(err);
67
+ throw new SidechatAPIError("Failed to request SMS verification.");
68
+ }
69
+ };
70
+
71
+ /**
72
+ * Verify the code sent via SMS with loginViaSMS(). If this function succeeds, the user will be authenticated for future requests.
73
+ * @method
74
+ * @since 1.0.0
75
+ * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
76
+ * @param {String} code - the verification code
77
+ */
78
+ verifySMSCode = async (phoneNumber, code) => {
79
+ try {
80
+ const res = await fetch(
81
+ `https://api.sidechat.lol/v1/verify_phone_number`,
82
+ {
83
+ method: "POST",
84
+ headers: this.defaultHeaders,
85
+ body: JSON.stringify({
86
+ phone_number: `+1${phoneNumber}`,
87
+ code: code.toUpperCase(),
88
+ }),
89
+ }
90
+ );
91
+ const json = await res.json();
92
+ if (json?.logged_in_user?.token) {
93
+ this.userToken = json.logged_in_user.token;
94
+ }
95
+ return json;
96
+ } catch (err) {
97
+ console.error(err);
98
+ throw new SidechatAPIError("Failed verify this code.");
99
+ }
100
+ };
101
+
102
+ /**
103
+ * Set the user's age. If this function succeeds, the user will be authenticated for future requests.
104
+ * @method
105
+ * @since 1.0.0
106
+ * @param {Number} age - user's age in years
107
+ * @param {String} registrationID - the registration ID generated by verifySMSCode()
108
+ */
109
+ setAge = async (age, registrationID) => {
110
+ if (age &lt; 13) {
111
+ throw new SidechatAPIError("You're too young to use Offsides.");
112
+ }
113
+ try {
114
+ const res = await fetch(
115
+ `https://api.sidechat.lol/v1/complete_registration`,
116
+ {
117
+ method: "POST",
118
+ headers: this.defaultHeaders,
119
+ body: JSON.stringify({
120
+ age: Number(age),
121
+ registration_id: registrationID,
122
+ }),
123
+ }
124
+ );
125
+ const json = await res.json();
126
+ if (json.token) {
127
+ this.userToken = json.token;
128
+ }
129
+ return json;
130
+ } catch (err) {
131
+ console.error(err);
132
+ throw new SidechatAPIError("Failed verify this code.");
133
+ }
134
+ };
135
+
136
+ /**
137
+ * Initiate the email setup process. Should be followed up with checkEmailVerification().
138
+ * @method
139
+ * @since 1.0.0
140
+ * @param {String} email - school email address to send verification code to
141
+ * @tutorial Email Registration
142
+ */
143
+ registerEmail = async (email) => {
144
+ if (!this.userToken) {
145
+ throw new SidechatAPIError("User is not authenticated.");
146
+ }
147
+ try {
148
+ const res = await fetch(
149
+ `https://api.sidechat.lol/v2/users/register_email`,
150
+ {
151
+ method: "POST",
152
+ headers: {
153
+ ...this.defaultHeaders,
154
+ Authorization: `Bearer ${this.userToken}`,
155
+ },
156
+ body: JSON.stringify({
157
+ email: email,
158
+ }),
159
+ }
160
+ );
161
+ const json = await res.json();
162
+ if (json.message) {
163
+ throw new SidechatAPIError(json.message);
164
+ }
165
+ return json;
166
+ } catch (err) {
167
+ console.error(error);
168
+ throw new SidechatAPIError("Failed to request email verification.");
169
+ }
170
+ };
171
+
172
+ /**
173
+ * Check is the user's email is verified.
174
+ * @method
175
+ * @since 1.0.0
176
+ */
177
+ checkEmailVerification = async () => {
178
+ if (!this.userToken) {
179
+ throw new SidechatAPIError("User is not authenticated.");
180
+ }
181
+ try {
182
+ const res = await fetch(
183
+ `https://api.sidechat.lol/v1/users/check_email_verified`,
184
+ {
185
+ method: "GET",
186
+ headers: {
187
+ ...this.defaultHeaders,
188
+ Authorization: `Bearer ${this.userToken}`,
189
+ },
190
+ }
191
+ );
192
+ const json = await res.json();
193
+ if (json.verified_email_updates_response) {
194
+ return json.verified_email_updates_response;
195
+ } else {
196
+ throw new SidechatAPIError(json?.message || "Email is not verified.");
197
+ }
198
+ } catch (err) {
199
+ console.error(error);
200
+ throw new SidechatAPIError("Email is not verified.");
201
+ }
202
+ };
203
+
204
+ /**
205
+ * Set the device ID of the current user
206
+ * @method
207
+ * @since 1.0.0
208
+ * @param {String} deviceId - the device ID to set
209
+ */
210
+ setDeviceID = async (deviceID) => {
211
+ if (!this.userToken) {
212
+ throw new SidechatAPIError("User is not authenticated.");
213
+ }
214
+ try {
215
+ const res = await fetch(
216
+ `https://api.sidechat.lol/v1/register_device_token`,
217
+ {
218
+ method: "POST",
219
+ headers: {
220
+ ...this.defaultHeaders,
221
+ Authorization: `Bearer ${this.userToken}`,
222
+ },
223
+ body: JSON.stringify({
224
+ build_type: "release",
225
+ bundle_id: "com.flowerave.sidechat",
226
+ device_token: deviceID,
227
+ }),
228
+ }
229
+ );
230
+ const json = await res.json();
231
+ await AsyncStorage.setItem("deviceID", deviceID);
232
+ return json;
233
+ } catch (err) {
234
+ console.error(err);
235
+ throw new SidechatAPIError("Failed verify this code.");
236
+ }
237
+ };
238
+
239
+ /**
240
+ * Get updated status for user and group
241
+ * @method
242
+ * @since 1.0.0
243
+ * @deprecated since 2.1.0, will be removed by 3.0.0. Please use `getUpdates` instead!
244
+ * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
245
+ */
246
+ getUserAndGroup = async (groupID = "") => {
247
+ const json = await this.getUpdates(groupID);
248
+ return json;
249
+ };
250
+
251
+ /**
252
+ * Get updated status for user and group
253
+ * @method
254
+ * @since 2.1.0
255
+ * @param {String} [groupID] - ID of a specific group to retrieve info from. Falls back to user's primary group.
256
+ */
257
+ getUpdates = async (groupID = "") => {
258
+ if (!this.userToken) {
259
+ throw new SidechatAPIError("User is not authenticated.");
260
+ }
261
+ try {
262
+ const res = await fetch(
263
+ `https://api.sidechat.lol/v1/updates?group_id=${groupID}`,
264
+ {
265
+ method: "GET",
266
+ headers: {
267
+ ...this.defaultHeaders,
268
+ Authorization: `Bearer ${this.userToken}`,
269
+ },
270
+ }
271
+ );
272
+ const json = await res.json();
273
+ return json;
274
+ } catch (err) {
275
+ console.error(err);
276
+ throw new SidechatAPIError(`Failed to get posts from group.`);
277
+ }
278
+ };
279
+
280
+ /**
281
+ * Fetches posts from the specified category in a group
282
+ * @method
283
+ * @since 1.0.0
284
+ * @param {String} groupID - group ID
285
+ * @param {"hot"|"recent"|"top"} category - category to filter posts
286
+ * @param {SidechatCursorString} [cursor] - cursor string
287
+ * @returns {SidechatPostsAndCursor} List of posts and cursor
288
+ */
289
+ getGroupPosts = async (groupID, category = "hot", cursor) => {
290
+ if (!this.userToken) {
291
+ throw new SidechatAPIError("User is not authenticated.");
292
+ }
293
+ try {
294
+ const res = await fetch(
295
+ `https://api.sidechat.lol/v1/posts?group_id=${groupID}&amp;type=${category}${
296
+ cursor ? "&amp;cursor=" + cursor : ""
297
+ }`,
298
+ {
299
+ method: "GET",
300
+ headers: {
301
+ ...this.defaultHeaders,
302
+ Authorization: `Bearer ${this.userToken}`,
303
+ },
304
+ }
305
+ );
306
+ const json = await res.json();
307
+ return json;
308
+ } catch (err) {
309
+ console.error(err);
310
+ throw new SidechatAPIError(`Failed to get posts from group.`);
311
+ }
312
+ };
313
+
314
+ /**
315
+ * Upvote or downvote, or unvote a post
316
+ * @method
317
+ * @since 2.0.0-alpha.0
318
+ * @param {String} postID - post ID to vote on
319
+ * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
320
+ */
321
+ setVote = async (postID, action) => {
322
+ if (!this.userToken) {
323
+ throw new SidechatAPIError("User is not authenticated.");
324
+ }
325
+ try {
326
+ const res = await fetch(`https://api.sidechat.lol/v1/posts/set_vote`, {
327
+ method: "POST",
328
+ headers: {
329
+ ...this.defaultHeaders,
330
+ Authorization: `Bearer ${this.userToken}`,
331
+ },
332
+ body: JSON.stringify({
333
+ post_id: postID,
334
+ vote_status: action,
335
+ }),
336
+ });
337
+ const json = await res.json();
338
+ return json;
339
+ } catch (err) {
340
+ console.error(err);
341
+ throw new SidechatAPIError(`Failed to change the vote on post.`);
342
+ }
343
+ };
344
+
345
+ /**
346
+ * Get all the commments on a post
347
+ * @method
348
+ * @since 2.0.0-alpha.0
349
+ * @param {String} postID - post ID to get comments for
350
+ * @returns {SidechatPostOrComment[]} list of comments
351
+ */
352
+ getPostComments = async (postID) => {
353
+ if (!this.userToken) {
354
+ throw new SidechatAPIError("User is not authenticated.");
355
+ }
356
+ try {
357
+ const res = await fetch(
358
+ `https://api.sidechat.lol/v1/posts/comments/?post_id=${postID}`,
359
+ {
360
+ method: "GET",
361
+ headers: {
362
+ ...this.defaultHeaders,
363
+ Authorization: `Bearer ${this.userToken}`,
364
+ },
365
+ }
366
+ );
367
+ const json = await res.json();
368
+ // Function to preprocess the comments and organize them into a nested structure
369
+ function preprocessComments(apiComments) {
370
+ // Map to store comments by their IDs for efficient lookup
371
+ const commentMap = new Map();
372
+ // List to store top-level comments
373
+ const topLevelComments = [];
374
+
375
+ // Iterate through the API comments
376
+ apiComments.forEach((comment) => {
377
+ // Store the comment in the map with its ID as the key
378
+ commentMap.set(comment.id, comment);
379
+ // Get the parent comment using the reply_post_id
380
+ const parentComment = commentMap.get(comment.reply_post_id);
381
+ // Check if the comment is a top-level comment
382
+ if (
383
+ !parentComment ||
384
+ comment.reply_post_id === comment.parent_post_id
385
+ ) {
386
+ // If it's a top-level comment, push it to the topLevelComments array
387
+ topLevelComments.push(comment);
388
+ } else {
389
+ // If it's a reply, add it to the parent comment's replies array
390
+ if (!parentComment.replies) parentComment.replies = [];
391
+ parentComment.replies.push(comment);
392
+ }
393
+ });
394
+
395
+ // Flatten the nested structure and return a single list of comments
396
+ return flattenComments(topLevelComments);
397
+ }
398
+
399
+ // Function to flatten nested comments into a single list
400
+ function flattenComments(comments) {
401
+ // Use reduce to flatten the nested comments array into a single list
402
+ return comments.reduce((flatComments, comment) => {
403
+ // Push the current comment to the flatComments array
404
+ flatComments.push(comment);
405
+ // If the current comment has replies, recursively flatten them and push to the flatComments array
406
+ if (comment.replies)
407
+ flatComments.push(...flattenComments(comment.replies));
408
+ // Return the flatComments array
409
+ return flatComments;
410
+ }, []);
411
+ }
412
+
413
+ const sortedComments = preprocessComments(json.posts);
414
+ return sortedComments;
415
+ } catch (err) {
416
+ console.error(err);
417
+ throw new SidechatAPIError(`Failed to get comments on post.`);
418
+ }
419
+ };
420
+
421
+ /**
422
+ * Gets groups to be displayed on the "Explore Groups" page
423
+ * @method
424
+ * @since 2.0.0-alpha.0
425
+ * @returns {SidechatGroup[]}
426
+ */
427
+ getAvailableGroups = async () => {
428
+ if (!this.userToken) {
429
+ throw new SidechatAPIError("User is not authenticated.");
430
+ }
431
+ try {
432
+ const res = await fetch(`https://api.sidechat.lol/v1/groups/explore`, {
433
+ method: "GET",
434
+ headers: {
435
+ ...this.defaultHeaders,
436
+ Authorization: `Bearer ${this.userToken}`,
437
+ },
438
+ });
439
+ const json = await res.json();
440
+ return await json.groups;
441
+ } catch (err) {
442
+ console.error(err);
443
+ throw new SidechatAPIError(`Failed to get groups from explore.`);
444
+ }
445
+ };
446
+
447
+ /**
448
+ * Retrieves the entire accessible asset library. Be warned that as of the time of this documentation, it's a 1.5MB JSON download and this request is very expensive.
449
+ * @method
450
+ * @since 2.0.6
451
+ * @returns {SidechatLibraryAsset[]}
452
+ */
453
+ getAssetLibrary = async () => {
454
+ if (!this.userToken) {
455
+ throw new SidechatAPIError("User is not authenticated.");
456
+ }
457
+ try {
458
+ const res = await fetch(`https://api.sidechat.lol/v1/assets/library`, {
459
+ method: "GET",
460
+ headers: {
461
+ ...this.defaultHeaders,
462
+ Authorization: `Bearer ${this.userToken}`,
463
+ },
464
+ });
465
+ const json = await res.json();
466
+ return await json.items;
467
+ } catch (err) {
468
+ console.error(err);
469
+ throw new SidechatAPIError(`Failed to get asset library.`);
470
+ }
471
+ };
472
+
473
+ /**
474
+ * Gets the current authenticated user and a list of the groups of which they are members.
475
+ * @method
476
+ * @since 2.1.0
477
+ * @returns {SidechatCurrentUser}
478
+ */
479
+ getCurrentUser = async () => {
480
+ if (!this.userToken) {
481
+ throw new SidechatAPIError("User is not authenticated.");
482
+ }
483
+ try {
484
+ const res = await fetch(`https://api.sidechat.lol/v1/users/me`, {
485
+ method: "GET",
486
+ headers: {
487
+ ...this.defaultHeaders,
488
+ Authorization: `Bearer ${this.userToken}`,
489
+ },
490
+ });
491
+ const json = await res.json();
492
+ return await json;
493
+ } catch (err) {
494
+ console.error(err);
495
+ throw new SidechatAPIError(`Failed to get asset library.`);
496
+ }
497
+ };
498
+
499
+ /**
500
+ * Gets the metadata of a group from its ID
501
+ * @method
502
+ * @since 2.1.0
503
+ * @param {String} [groupID] - alphanumeric ID of a group to get. Falls back to user's primary group.
504
+ * @returns {SidechatGroup}
505
+ */
506
+ getGroupMetadata = async (groupID = "") => {
507
+ if (!this.userToken) {
508
+ throw new SidechatAPIError("User is not authenticated.");
509
+ }
510
+ try {
511
+ const res = await fetch(`https://api.sidechat.lol/v1/groups/${groupID}`, {
512
+ method: "GET",
513
+ headers: {
514
+ ...this.defaultHeaders,
515
+ Authorization: `Bearer ${this.userToken}`,
516
+ },
517
+ });
518
+ const json = await res.json();
519
+ return await json.group;
520
+ } catch (err) {
521
+ console.error(err);
522
+ throw new SidechatAPIError(`Failed to get group metadata.`);
523
+ }
524
+ };
525
+
526
+ /**
527
+ * Creates a comment on a post
528
+ * @method
529
+ * @since 2.2.0
530
+ * @param {String} parentPostID - alphanumeric ID of post on which this comment is made
531
+ * @param {String} text - text content of comment
532
+ * @param {String} groupID - alphanumeric ID of group in which the parent post resides
533
+ * @param {String} [replyCommentID] - alphanumeric ID of comment to reply to. Falls back to parentPostID
534
+ * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach
535
+ * @param {Boolean} [disableDMs] - prevent direct messages being sent to comment's author
536
+ * @returns {SidechatPostOrComment} created comment
537
+ */
538
+ createComment = async (
539
+ parentPostID,
540
+ text,
541
+ groupID,
542
+ replyCommentID = parentPostID,
543
+ assetList = [],
544
+ disableDMs = false
545
+ ) => {
546
+ if (!this.userToken) {
547
+ throw new SidechatAPIError("User is not authenticated.");
548
+ }
549
+ try {
550
+ const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
551
+ method: "POST",
552
+ headers: {
553
+ ...this.defaultHeaders,
554
+ Authorization: `Bearer ${this.userToken}`,
555
+ },
556
+ body: JSON.stringify({
557
+ type: "comment",
558
+ assets: assetList,
559
+ group_ids: [groupID],
560
+ text: text,
561
+ reply_post_id: replyCommentID,
562
+ parent_post_id: parentPostID,
563
+ dms_disabled: disableDMs,
564
+ }),
565
+ });
566
+ const json = await res.json();
567
+ return await json.comment;
568
+ } catch (err) {
569
+ console.error(err);
570
+ throw new SidechatAPIError(`Failed to post comment.`);
571
+ }
572
+ };
573
+
574
+ /**
575
+ * Creates a new post in the specified group
576
+ * @method
577
+ * @since 2.2.0
578
+ * @param {String} text - text content of comment
579
+ * @param {String} groupID - alphanumeric ID of group in which the parent post resides
580
+ * @param {SidechatSimpleAsset[]} [assetList] - list of assets to attach.
581
+ * @param {Boolean} [disableDMs] - prevent direct messages from being sent to post's author
582
+ * @param {Boolean} [disableComments] - whether or not comments should be disabled on post
583
+ * @returns {SidechatPostOrComment} the created post
584
+ */
585
+ createPost = async (
586
+ text,
587
+ groupID,
588
+ assetList = [],
589
+ disableDMs = false,
590
+ disableComments = false
591
+ ) => {
592
+ if (!this.userToken) {
593
+ throw new SidechatAPIError("User is not authenticated.");
594
+ }
595
+ try {
596
+ const res = await fetch(`https://api.sidechat.lol/v1/posts`, {
597
+ method: "POST",
598
+ headers: {
599
+ ...this.defaultHeaders,
600
+ Authorization: `Bearer ${this.userToken}`,
601
+ },
602
+ body: JSON.stringify({
603
+ type: "post",
604
+ assets: assetList,
605
+ group_ids: [groupID],
606
+ text: text,
607
+ attachments: [],
608
+ dms_disabled: disableDMs,
609
+ comments_disabled: disableComments,
610
+ }),
611
+ });
612
+ const json = await res.json();
613
+ return await json.posts[0];
614
+ } catch (err) {
615
+ console.error(err);
616
+ throw new SidechatAPIError(`Failed to make post.`);
617
+ }
618
+ };
619
+
620
+ /**
621
+ * Deletes a post or comment that the user created
622
+ * @method
623
+ * @since 2.2.0
624
+ * @param {String} postOrCommentID - alphanumeric ID of post to delete
625
+ */
626
+ deletePostOrComment = async (postOrCommentID) => {
627
+ if (!this.userToken) {
628
+ throw new SidechatAPIError("User is not authenticated.");
629
+ }
630
+ try {
631
+ const res = await fetch(`https://api.sidechat.lol/v1/posts/delete`, {
632
+ method: "POST",
633
+ headers: {
634
+ ...this.defaultHeaders,
635
+ Authorization: `Bearer ${this.userToken}`,
636
+ },
637
+ body: JSON.stringify({
638
+ post_id: postOrCommentID,
639
+ }),
640
+ });
641
+ const json = await res.json();
642
+ return await json;
643
+ } catch (err) {
644
+ console.error(err);
645
+ throw new SidechatAPIError(`Failed to delete post.`);
646
+ }
647
+ };
648
+
649
+ /**
650
+ * Sets the conversation icon of the current user
651
+ * @method
652
+ * @since 2.2.1
653
+ * @param {String} userID - alphanumeric ID of the post to delete
654
+ * @param {String} emoji - emoji to set as icon
655
+ * @param {String} primaryColor - hex string (including #) of primary color
656
+ * @param {String} secondaryColor - hex string (including #) of secondary color
657
+ */
658
+ setUserIcon = async (userID, emoji, primaryColor, secondaryColor) => {
659
+ if (!this.userToken) {
660
+ throw new SidechatAPIError("User is not authenticated.");
661
+ }
662
+ try {
663
+ const res = await fetch(`https://api.sidechat.lol/v1/users/${userID}`, {
664
+ method: "PATCH",
665
+ headers: {
666
+ ...this.defaultHeaders,
667
+ Authorization: `Bearer ${this.userToken}`,
668
+ },
669
+ body: JSON.stringify({
670
+ conversation_icon: {
671
+ emoji: emoji,
672
+ secondary_color: secondaryColor,
673
+ is_migrated: false,
674
+ color: primaryColor,
675
+ },
676
+ }),
677
+ });
678
+ const json = await res.json();
679
+ return await json;
680
+ } catch (err) {
681
+ console.error(err);
682
+ throw new SidechatAPIError(`Failed to set icon.`);
683
+ }
684
+ };
685
+ }
686
+
687
+ export default SidechatAPIClient;
688
+ </code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Home</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://github.com/micahlt/offsides#README.md" target="_blank">Offsides (Sidechat for Android)</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Authentication.html">Authentication</a></div><div class="sidebar-section-children"><a href="tutorial-Email Registration.html">Email Registration</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="SidechatAPIClient.html">SidechatAPIClient</a></div><div class="sidebar-section-children"><a href="SidechatAPIError.html">SidechatAPIError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#SidechatAssetMetadata">SidechatAssetMetadata</a></div><div class="sidebar-section-children"><a href="global.html#SidechatAuthToken">SidechatAuthToken</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCurrentUser">SidechatCurrentUser</a></div><div class="sidebar-section-children"><a href="global.html#SidechatCursorString">SidechatCursorString</a></div><div class="sidebar-section-children"><a href="global.html#SidechatGroup">SidechatGroup</a></div><div class="sidebar-section-children"><a href="global.html#SidechatIdentity">SidechatIdentity</a></div><div class="sidebar-section-children"><a href="global.html#SidechatLibraryAsset">SidechatLibraryAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatMembership">SidechatMembership</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostOrComment">SidechatPostOrComment</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPostsAndCursor">SidechatPostsAndCursor</a></div><div class="sidebar-section-children"><a href="global.html#SidechatPrivateAssetURL">SidechatPrivateAssetURL</a></div><div class="sidebar-section-children"><a href="global.html#SidechatSimpleAsset">SidechatSimpleAsset</a></div><div class="sidebar-section-children"><a href="global.html#SidechatVoteString">SidechatVoteString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>