sidechat.js 2.0.5 → 2.0.6

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 (43) hide show
  1. package/dist/classes/SidechatAPIClient.d.ts +20 -2
  2. package/dist/classes/SidechatAPIClient.d.ts.map +1 -1
  3. package/dist/index.cjs +39 -2
  4. package/dist/index.mjs +39 -2
  5. package/dist/types/SidechatTypes.d.ts +45 -3
  6. package/dist/types/SidechatTypes.d.ts.map +1 -1
  7. package/docs/sidechat.js/2.0.6/SidechatAPIClient.html +3 -0
  8. package/docs/sidechat.js/2.0.6/SidechatAPIError.html +3 -0
  9. package/docs/sidechat.js/2.0.6/classes_SidechatAPIClient.js.html +462 -0
  10. package/docs/sidechat.js/2.0.6/classes_SidechatAPIError.js.html +16 -0
  11. package/docs/sidechat.js/2.0.6/data/search.json +1 -0
  12. package/docs/sidechat.js/2.0.6/fonts/Inconsolata-Regular.ttf +0 -0
  13. package/docs/sidechat.js/2.0.6/fonts/OpenSans-Regular.ttf +0 -0
  14. package/docs/sidechat.js/2.0.6/fonts/WorkSans-Bold.ttf +0 -0
  15. package/docs/sidechat.js/2.0.6/global.html +3 -0
  16. package/docs/sidechat.js/2.0.6/index.html +4 -0
  17. package/docs/sidechat.js/2.0.6/scripts/core.js +702 -0
  18. package/docs/sidechat.js/2.0.6/scripts/core.min.js +23 -0
  19. package/docs/sidechat.js/2.0.6/scripts/resize.js +90 -0
  20. package/docs/sidechat.js/2.0.6/scripts/search.js +265 -0
  21. package/docs/sidechat.js/2.0.6/scripts/search.min.js +6 -0
  22. package/docs/sidechat.js/2.0.6/scripts/third-party/Apache-License-2.0.txt +202 -0
  23. package/docs/sidechat.js/2.0.6/scripts/third-party/fuse.js +9 -0
  24. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num-original.js +369 -0
  25. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-line-num.js +1 -0
  26. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs-original.js +5171 -0
  27. package/docs/sidechat.js/2.0.6/scripts/third-party/hljs.js +1 -0
  28. package/docs/sidechat.js/2.0.6/scripts/third-party/popper.js +5 -0
  29. package/docs/sidechat.js/2.0.6/scripts/third-party/tippy.js +1 -0
  30. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.js +672 -0
  31. package/docs/sidechat.js/2.0.6/scripts/third-party/tocbot.min.js +1 -0
  32. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-base.css +975 -0
  33. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-dark.css +407 -0
  34. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme-light.css +388 -0
  35. package/docs/sidechat.js/2.0.6/styles/clean-jsdoc-theme.min.css +1 -0
  36. package/docs/sidechat.js/2.0.6/tutorial-Authentication.html +13 -0
  37. package/docs/sidechat.js/2.0.6/tutorial-Email Registration.html +6 -0
  38. package/docs/sidechat.js/2.0.6/types_SidechatTypes.js.html +114 -0
  39. package/package.json +54 -53
  40. package/src/classes/SidechatAPIClient.js +39 -2
  41. package/src/index.js +1 -1
  42. package/src/tests/basicTest.js +6 -4
  43. package/src/types/SidechatTypes.js +20 -2
package/docs/sidechat.js/2.0.6/types_SidechatTypes.js.html ADDED
@@ -0,0 +1,114 @@
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: types/SidechatTypes.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#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#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">types_SidechatTypes.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
4
+ * A user-created post or comment, depending on the "type" prop
5
+ * @typedef {Object} SidechatPostOrComment
6
+ * @prop {"post"|"comment"} type - whether this object represents a post or a comment on a post
7
+ * @prop {String} id - alphanumeric ID of post or comment
8
+ * @prop {Boolean} authored_by_user - undocumented
9
+ * @prop {String} alias - post creator's name in-app
10
+ * @prop {String} group_id - alphanumeric ID of group
11
+ * @prop {SidechatGroup} group - group in which post or comment was created
12
+ * @prop {String} text - text content of post or comment
13
+ * @prop {String} created_at - date string of post or comment creation time
14
+ * @prop {Number} vote_total - sum of upvotes and downvotes
15
+ * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
16
+ * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
17
+ * @prop {Array} attachments - undocumented
18
+ * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
19
+ * @prop {Array} tags - undocumented
20
+ * @prop {SidechatIdentity} identity - creator's identity information
21
+ * @prop {Boolean} pinned - undocumented
22
+ * @prop {Boolean} is_saved - undocumented
23
+ * @prop {"following"|"not_following"} follow_status - undocumented
24
+ * @prop {"group"} [destination] - undocumented
25
+ * @prop {Number} [comment_count] - number of comments on post (only if type=post)
26
+ * @prop {Boolean} [comments_disabled] - whether or not you can comment on post (only if type=post)
27
+ * @prop {String} [parent_post_id] - alphanumeric ID of parent post (only if type=comment)
28
+ * @prop {String} [reply_post_id] - alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
29
+ * @prop {String} [context] - text content of comment being replied to, falls back to text (only if type=comment)
30
+ */
31
+
32
+ /**
33
+ * A group object, containing metadata about a group as well as its join conditions and states
34
+ * @typedef {Object} SidechatGroup
35
+ * @prop {String} id - alphanumeric ID of group
36
+ * @prop {String} name - human-readable name of group
37
+ * @prop {String} analytics_name - name to file group under
38
+ * @prop {"non_member"|"member"} membership_type - whether or not current user is a member of group
39
+ * @prop {String} color - group's theme color as hex code (e.g., #FFFFFF)
40
+ * @prop {"open"|"closed"|"email_domain"} group_join_type - basis on which group accepts new members
41
+ * @prop {"private"|"public_to_all"|"public_to_schools"} group_visibility - group's visibility setting
42
+ * @prop {"show"|"hide"} asset_library_visibility - whether or not group's asset library is visible
43
+ * @prop {Array} [roles] - undocumented
44
+ * @prop {String} [description] - description of group
45
+ * @prop {SidechatPrivateAssetURL} [icon_url] - image URL for group icon
46
+ * @prop {Number} [member_count] - number of users in group
47
+ * @prop {Boolean} [should_show_leaderboard] - undocumented
48
+ */
49
+
50
+ /**
51
+ * An asset object, containing information about an image within a post or comment
52
+ * @typedef {Object} SidechatSimpleAsset
53
+ * @prop {String} id - alphanumeric ID of asset
54
+ * @prop {"image"} type - undocumented
55
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
56
+ * @prop {Number} width - the width of asset
57
+ * @prop {Number} height - the height of asset
58
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
59
+ */
60
+
61
+ /**
62
+ * An asset object, containing information about an image from the asset library
63
+ * @typedef {Object} SidechatLibraryAsset
64
+ * @prop {String} id - alphanumeric ID of asset
65
+ * @prop {String} created_at - date string of asset creation time
66
+ * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
67
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
68
+ */
69
+
70
+ /**
71
+ * An asset object, containing information about an image from the asset library
72
+ * @typedef {Object} SidechatAssetMetadata
73
+ * @prop {Number} width - the width of asset
74
+ * @prop {Number} height - the height of asset
75
+ * @prop {"image"} type - undocumented
76
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
77
+ */
78
+
79
+ /**
80
+ * A user's identity information
81
+ * @typedef {Object} SidechatIdentity
82
+ * @prop {String} name - representation of user's name (varies across app)
83
+ * @prop {Boolean} posted_with_username - undocumented
84
+ */
85
+
86
+ /**
87
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
88
+ * @typedef {String} SidechatPrivateAssetURL
89
+ */
90
+
91
+ /**
92
+ * A cursor for paginating through post lists
93
+ * @typedef {String} SidechatCursorString
94
+ */
95
+
96
+ /**
97
+ * A vote on a comment or post
98
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
99
+ */
100
+
101
+ /**
102
+ * A user's bearer authentication token needed for most requests
103
+ * @typedef {String} SidechatAuthToken
104
+ */
105
+
106
+ /**
107
+ * A list of posts and the associated cursor
108
+ * @typedef {Object} SidechatPostsAndCursor
109
+ * @prop {SidechatPostOrComment[]} posts
110
+ * @prop {SidechatCursorString} cursor
111
+ */
112
+
113
+ export default {};
114
+ </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#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#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>
package/package.json CHANGED
@@ -1,53 +1,54 @@
1
- {
2
- "name": "sidechat.js",
3
- "version": "2.0.5",
4
- "description": "A reverse-engineered API wrapper for Sidechat",
5
- "type": "module",
6
- "source": "./src/index.js",
7
- "main": "./dist/index.cjs",
8
- "module": "./dist/index.mjs",
9
- "types": "./dist/index.d.ts",
10
- "exports": {
11
- ".": {
12
- "import": {
13
- "types": "./dist/index.d.mts",
14
- "default": "./dist/index.mjs"
15
- },
16
- "require": {
17
- "types": "./dist/index.d.ts",
18
- "default": "./dist/index.cjs"
19
- }
20
- },
21
- "./src/types": {
22
- "types": "./dist/types/SidechatTypes.d.ts",
23
- "default": "./src/types/SidechatTypes.js"
24
- }
25
- },
26
- "scripts": {
27
- "build": "rollup -c",
28
- "dev": "rollup -c --watch",
29
- "docs": "jsdoc --configure jsdoc.json --verbose",
30
- "prepublish": "tsc",
31
- "typegen": "tsc"
32
- },
33
- "repository": {
34
- "type": "git",
35
- "url": "git+https://github.com/micahlt/sidechat.js.git"
36
- },
37
- "author": "Micah Lindley",
38
- "license": "MIT",
39
- "bugs": {
40
- "url": "https://github.com/micahlt/sidechat.js/issues"
41
- },
42
- "homepage": "https://github.com/micahlt/sidechat.js#readme",
43
- "engines": {
44
- "node": ">=18.0.0"
45
- },
46
- "devDependencies": {
47
- "clean-jsdoc-theme": "^4.2.17",
48
- "prompt-sync": "^4.2.0",
49
- "rollup": "^2.79.1",
50
- "rollup-plugin-copy": "^3.5.0",
51
- "typescript": "^5.4.2"
52
- }
53
- }
1
+ {
2
+ "name": "sidechat.js",
3
+ "version": "2.0.6",
4
+ "description": "A reverse-engineered API wrapper for Sidechat",
5
+ "type": "module",
6
+ "source": "./src/index.js",
7
+ "main": "./dist/index.cjs",
8
+ "module": "./dist/index.mjs",
9
+ "types": "./dist/index.d.ts",
10
+ "exports": {
11
+ ".": {
12
+ "import": {
13
+ "types": "./dist/index.d.mts",
14
+ "default": "./dist/index.mjs"
15
+ },
16
+ "require": {
17
+ "types": "./dist/index.d.ts",
18
+ "default": "./dist/index.cjs"
19
+ }
20
+ },
21
+ "./src/types": {
22
+ "types": "./dist/types/SidechatTypes.d.ts",
23
+ "default": "./src/types/SidechatTypes.js"
24
+ }
25
+ },
26
+ "scripts": {
27
+ "build": "rollup -c",
28
+ "dev": "rollup -c --watch",
29
+ "docs": "jsdoc --configure jsdoc.json --verbose",
30
+ "prepublish": "tsc",
31
+ "typegen": "tsc"
32
+ },
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "git+https://github.com/micahlt/sidechat.js.git"
36
+ },
37
+ "author": "Micah Lindley",
38
+ "license": "MIT",
39
+ "bugs": {
40
+ "url": "https://github.com/micahlt/sidechat.js/issues"
41
+ },
42
+ "homepage": "https://github.com/micahlt/sidechat.js#readme",
43
+ "engines": {
44
+ "node": ">=18.0.0"
45
+ },
46
+ "devDependencies": {
47
+ "clean-jsdoc-theme": "^4.2.17",
48
+ "dotenv": "^16.4.5",
49
+ "prompt-sync": "^4.2.0",
50
+ "rollup": "^2.79.1",
51
+ "rollup-plugin-copy": "^3.5.0",
52
+ "typescript": "^5.4.2"
53
+ }
54
+ }
package/src/classes/SidechatAPIClient.js CHANGED
@@ -44,6 +44,7 @@ class SidechatAPIClient {
44
44
  /**
45
45
  * Initiate the login process with a phone number. Should be followed up with verifySMSCode().
46
46
  * @method
47
+ * @since 1.0.0
47
48
  * @param {Number} phoneNumber - US phone number (WITHOUT +1) to send verification code to
48
49
  */
49
50
  loginViaSMS = async (phoneNumber) => {
@@ -65,8 +66,9 @@ class SidechatAPIClient {
65
66
  };
66
67
 
67
68
  /**
68
- * Verify the code sent via SMS with loginViaSMS().
69
+ * Verify the code sent via SMS with loginViaSMS(). If this function succeeds, the user will be authenticated for future requests.
69
70
  * @method
71
+ * @since 1.0.0
70
72
  * @param {Number} phoneNumber - US phone number (WITHOUT +1) that verification code was sent to
71
73
  * @param {String} code - the verification code
72
74
  */
@@ -95,8 +97,9 @@ class SidechatAPIClient {
95
97
  };
96
98
 
97
99
  /**
98
- * Set the user's age
100
+ * Set the user's age. If this function succeeds, the user will be authenticated for future requests.
99
101
  * @method
102
+ * @since 1.0.0
100
103
  * @param {Number} age - user's age in years
101
104
  * @param {String} registrationID - the registration ID generated by verifySMSCode()
102
105
  */
@@ -130,6 +133,7 @@ class SidechatAPIClient {
130
133
  /**
131
134
  * Initiate the email setup process. Should be followed up with checkEmailVerification().
132
135
  * @method
136
+ * @since 1.0.0
133
137
  * @param {String} email - school email address to send verification code to
134
138
  * @tutorial Email Registration
135
139
  */
@@ -165,6 +169,7 @@ class SidechatAPIClient {
165
169
  /**
166
170
  * Check is the user's email is verified.
167
171
  * @method
172
+ * @since 1.0.0
168
173
  */
169
174
  checkEmailVerification = async () => {
170
175
  if (!this.userToken) {
@@ -196,6 +201,7 @@ class SidechatAPIClient {
196
201
  /**
197
202
  * Set the device ID of the current user
198
203
  * @method
204
+ * @since 1.0.0
199
205
  * @param {String} deviceId - the device ID to set
200
206
  */
201
207
  setDeviceID = async (deviceID) => {
@@ -230,6 +236,7 @@ class SidechatAPIClient {
230
236
  /**
231
237
  * Get updated status for user and group
232
238
  * @method
239
+ * @since 1.0.0
233
240
  * @param {String} [groupID] - ID of a specific group to retrieve info from
234
241
  */
235
242
  getUserAndGroup = async (groupID = "") => {
@@ -258,6 +265,7 @@ class SidechatAPIClient {
258
265
  /**
259
266
  * Fetches posts from the specified category in a group
260
267
  * @method
268
+ * @since 1.0.0
261
269
  * @param {String} groupID - group ID
262
270
  * @param {"hot"|"recent"|"top"} category - category to filter posts
263
271
  * @param {SidechatCursorString} [cursor] - cursor string
@@ -291,6 +299,7 @@ class SidechatAPIClient {
291
299
  /**
292
300
  * Upvote or downvote, or unvote a post
293
301
  * @method
302
+ * @since 2.0.0-alpha.0
294
303
  * @param {String} postID - post ID to vote on
295
304
  * @param {SidechatVoteString} action - whether to upvote, downvote, or reset vote
296
305
  */
@@ -321,6 +330,7 @@ class SidechatAPIClient {
321
330
  /**
322
331
  * Get all the commments on a post
323
332
  * @method
333
+ * @since 2.0.0-alpha.0
324
334
  * @param {String} postID - post ID to get comments for
325
335
  * @returns {SidechatPostOrComment[]} list of comments
326
336
  */
@@ -396,6 +406,7 @@ class SidechatAPIClient {
396
406
  /**
397
407
  * Gets groups to be displayed on the "Explore Groups" page
398
408
  * @method
409
+ * @since 2.0.0-alpha.0
399
410
  * @returns {SidechatGroup[]}
400
411
  */
401
412
  getAvailableGroups = async () => {
@@ -417,6 +428,32 @@ class SidechatAPIClient {
417
428
  throw new SidechatAPIError(`Failed to get groups from explore.`);
418
429
  }
419
430
  };
431
+
432
+ /**
433
+ * 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.
434
+ * @method
435
+ * @since 2.0.6
436
+ * @returns {SidechatLibraryAsset[]}
437
+ */
438
+ getAssetLibrary = async () => {
439
+ if (!this.userToken) {
440
+ throw new SidechatAPIError("User is not authenticated.");
441
+ }
442
+ try {
443
+ const res = await fetch(`https://api.sidechat.lol/v1/assets/library`, {
444
+ method: "GET",
445
+ headers: {
446
+ ...this.defaultHeaders,
447
+ Authorization: `Bearer ${this.userToken}`,
448
+ },
449
+ });
450
+ const json = await res.json();
451
+ return await json.items;
452
+ } catch (err) {
453
+ console.error(err);
454
+ throw new SidechatAPIError(`Failed to get asset library.`);
455
+ }
456
+ };
420
457
  }
421
458
 
422
459
  export default SidechatAPIClient;
package/src/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import "./types/SidechatTypes";
1
+ import "./types/SidechatTypes.js";
2
2
  import SidechatAPIClient from "./classes/SidechatAPIClient.js";
3
3
  import SidechatAPIError from "./classes/SidechatAPIError.js";
4
4
 
package/src/tests/basicTest.js CHANGED
@@ -1,18 +1,20 @@
1
+ import { configDotenv } from "dotenv";
1
2
  import { SidechatAPIClient } from "../index.js";
2
3
  import PromptSync from "prompt-sync";
3
4
  const prompt = new PromptSync();
5
+ configDotenv({ path: ".env.local", debug: true });
4
6
 
5
7
  async function main() {
6
- const API = new SidechatAPIClient(
7
- "eyJhbGciOiJIUzI1NiJ9.ZTViNjFiMzktM2UwNi00NGU1LTg1M2YtMTg2MDNhOWQzOWM5.gOl2_HPyPzcyNpTXqSQEuJ3ZUmZi7Zq_vSBoRfbKA1A"
8
- );
9
- if (API.userToken) {
8
+ const API = new SidechatAPIClient(process.env.SIDECHAT_TOKEN);
9
+ if (!API.userToken) {
10
10
  const phoneNum = prompt("Phone number: ");
11
11
  await API.loginViaSMS(phoneNum);
12
12
  const code = prompt("Code: ");
13
13
  await API.verifySMSCode(phoneNum, code);
14
14
  console.log("User auth token:", API.userToken);
15
15
  } else {
16
+ const lib = await API.getAssetLibrary();
17
+ console.log(lib);
16
18
  }
17
19
  }
18
20
 
package/src/types/SidechatTypes.js CHANGED
@@ -11,7 +11,7 @@
11
11
  * @prop {String} created_at - date string of post or comment creation time
12
12
  * @prop {Number} vote_total - sum of upvotes and downvotes
13
13
  * @prop {SidechatVoteString} vote_status - current user's vote on post or comment
14
- * @prop {SidechatAsset[]} assets - array of assets attached to post or comment
14
+ * @prop {SidechatSimpleAsset[]} assets - array of simple assets attached to post or comment
15
15
  * @prop {Array} attachments - undocumented
16
16
  * @prop {Boolean} dms_disabled - whether or not you can send a DM to creator of post
17
17
  * @prop {Array} tags - undocumented
@@ -47,7 +47,7 @@
47
47
 
48
48
  /**
49
49
  * An asset object, containing information about an image within a post or comment
50
- * @typedef {Object} SidechatAsset
50
+ * @typedef {Object} SidechatSimpleAsset
51
51
  * @prop {String} id - alphanumeric ID of asset
52
52
  * @prop {"image"} type - undocumented
53
53
  * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
@@ -56,6 +56,24 @@
56
56
  * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
57
57
  */
58
58
 
59
+ /**
60
+ * An asset object, containing information about an image from the asset library
61
+ * @typedef {Object} SidechatLibraryAsset
62
+ * @prop {String} id - alphanumeric ID of asset
63
+ * @prop {String} created_at - date string of asset creation time
64
+ * @prop {SidechatAssetMetadata} metadata - metadata associated with asset
65
+ * @prop {SidechatPrivateAssetURL} url - URL string of asset's location
66
+ */
67
+
68
+ /**
69
+ * An asset object, containing information about an image from the asset library
70
+ * @typedef {Object} SidechatAssetMetadata
71
+ * @prop {Number} width - the width of asset
72
+ * @prop {Number} height - the height of asset
73
+ * @prop {"image"} type - undocumented
74
+ * @prop {"jpeg"|"png"|"gif"} content_type - file type of asset
75
+ */
76
+
59
77
  /**
60
78
  * A user's identity information
61
79
  * @typedef {Object} SidechatIdentity