sidechat.js 1.0.0 → 2.0.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 (90) hide show
  1. package/.github/workflows/static.yml +51 -0
  2. package/README.md +15 -1
  3. package/dist/sidechat.cjs +1 -1
  4. package/dist/sidechat.cjs.map +1 -1
  5. package/dist/sidechat.modern.js +1 -1
  6. package/dist/sidechat.modern.js.map +1 -1
  7. package/dist/sidechat.module.js +1 -1
  8. package/dist/sidechat.module.js.map +1 -1
  9. package/dist/sidechat.umd.js +1 -1
  10. package/dist/sidechat.umd.js.map +1 -1
  11. package/docs/sidechat.js/1.0.0/global.html +1 -1
  12. package/docs/sidechat.js/1.0.0/index.html +2 -1
  13. package/docs/sidechat.js/1.0.0/index.js.html +1 -3
  14. package/docs/sidechat.js/1.0.0/types_SidechatTypes.js.html +1 -1
  15. package/docs/sidechat.js/2.0.0/SidechatAPIClient.html +3 -0
  16. package/docs/sidechat.js/2.0.0/SidechatAPIError.html +3 -0
  17. package/docs/sidechat.js/2.0.0/classes_SidechatAPIClient.js.html +425 -0
  18. package/docs/sidechat.js/2.0.0/classes_SidechatAPIError.js.html +16 -0
  19. package/docs/sidechat.js/2.0.0/data/search.json +1 -0
  20. package/docs/sidechat.js/2.0.0/fonts/Inconsolata-Regular.ttf +0 -0
  21. package/docs/sidechat.js/2.0.0/fonts/OpenSans-Regular.ttf +0 -0
  22. package/docs/sidechat.js/2.0.0/fonts/WorkSans-Bold.ttf +0 -0
  23. package/docs/sidechat.js/2.0.0/global.html +3 -0
  24. package/docs/sidechat.js/2.0.0/index.html +4 -0
  25. package/docs/sidechat.js/2.0.0/scripts/core.js +702 -0
  26. package/docs/sidechat.js/2.0.0/scripts/core.min.js +23 -0
  27. package/docs/sidechat.js/2.0.0/scripts/resize.js +90 -0
  28. package/docs/sidechat.js/2.0.0/scripts/search.js +265 -0
  29. package/docs/sidechat.js/2.0.0/scripts/search.min.js +6 -0
  30. package/docs/sidechat.js/2.0.0/scripts/third-party/Apache-License-2.0.txt +202 -0
  31. package/docs/sidechat.js/2.0.0/scripts/third-party/fuse.js +9 -0
  32. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num-original.js +369 -0
  33. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-line-num.js +1 -0
  34. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs-original.js +5171 -0
  35. package/docs/sidechat.js/2.0.0/scripts/third-party/hljs.js +1 -0
  36. package/docs/sidechat.js/2.0.0/scripts/third-party/popper.js +5 -0
  37. package/docs/sidechat.js/2.0.0/scripts/third-party/tippy.js +1 -0
  38. package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.js +672 -0
  39. package/docs/sidechat.js/2.0.0/scripts/third-party/tocbot.min.js +1 -0
  40. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-base.css +975 -0
  41. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-dark.css +407 -0
  42. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme-light.css +388 -0
  43. package/docs/sidechat.js/2.0.0/styles/clean-jsdoc-theme.min.css +1 -0
  44. package/docs/sidechat.js/2.0.0/tutorial-Authentication.html +13 -0
  45. package/docs/sidechat.js/2.0.0/tutorial-Email Registration.html +6 -0
  46. package/docs/sidechat.js/2.0.0/types_SidechatTypes.js.html +98 -0
  47. package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIClient.html +3 -0
  48. package/docs/sidechat.js/2.0.0-alpha.0/SidechatAPIError.html +3 -0
  49. package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIClient.js.html +418 -0
  50. package/docs/sidechat.js/2.0.0-alpha.0/classes_SidechatAPIError.js.html +16 -0
  51. package/docs/sidechat.js/2.0.0-alpha.0/data/search.json +1 -0
  52. package/docs/sidechat.js/2.0.0-alpha.0/fonts/Inconsolata-Regular.ttf +0 -0
  53. package/docs/sidechat.js/2.0.0-alpha.0/fonts/OpenSans-Regular.ttf +0 -0
  54. package/docs/sidechat.js/2.0.0-alpha.0/fonts/WorkSans-Bold.ttf +0 -0
  55. package/docs/sidechat.js/2.0.0-alpha.0/global.html +3 -0
  56. package/docs/sidechat.js/2.0.0-alpha.0/index.html +4 -0
  57. package/docs/sidechat.js/2.0.0-alpha.0/scripts/core.js +702 -0
  58. package/docs/sidechat.js/2.0.0-alpha.0/scripts/core.min.js +23 -0
  59. package/docs/sidechat.js/2.0.0-alpha.0/scripts/resize.js +90 -0
  60. package/docs/sidechat.js/2.0.0-alpha.0/scripts/search.js +265 -0
  61. package/docs/sidechat.js/2.0.0-alpha.0/scripts/search.min.js +6 -0
  62. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/Apache-License-2.0.txt +202 -0
  63. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/fuse.js +9 -0
  64. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/hljs-line-num-original.js +369 -0
  65. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/hljs-line-num.js +1 -0
  66. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/hljs-original.js +5171 -0
  67. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/hljs.js +1 -0
  68. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/popper.js +5 -0
  69. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/tippy.js +1 -0
  70. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/tocbot.js +672 -0
  71. package/docs/sidechat.js/2.0.0-alpha.0/scripts/third-party/tocbot.min.js +1 -0
  72. package/docs/sidechat.js/2.0.0-alpha.0/styles/clean-jsdoc-theme-base.css +975 -0
  73. package/docs/sidechat.js/2.0.0-alpha.0/styles/clean-jsdoc-theme-dark.css +407 -0
  74. package/docs/sidechat.js/2.0.0-alpha.0/styles/clean-jsdoc-theme-light.css +388 -0
  75. package/docs/sidechat.js/2.0.0-alpha.0/styles/clean-jsdoc-theme.min.css +1 -0
  76. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Authentication.html +13 -0
  77. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Registration.html +6 -0
  78. package/docs/sidechat.js/2.0.0-alpha.0/tutorial-Email Verification.html +6 -0
  79. package/docs/sidechat.js/2.0.0-alpha.0/types_SidechatTypes.js.html +98 -0
  80. package/docs/tutorials/Authentication.md +46 -0
  81. package/docs/tutorials/Email Registration.md +16 -0
  82. package/jsdoc.json +8 -4
  83. package/package.json +5 -4
  84. package/src/classes/SidechatAPIClient.js +422 -0
  85. package/{classes → src/classes}/SidechatAPIError.js +5 -0
  86. package/src/index.js +4 -0
  87. package/src/tests/basicTest.js +19 -0
  88. package/{types → src/types}/SidechatTypes.js +17 -1
  89. package/index.js +0 -362
  90. package/tests/basicTest.js +0 -8
package/docs/sidechat.js/2.0.0-alpha.0/types_SidechatTypes.js.html ADDED
@@ -0,0 +1,98 @@
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#SidechatAsset">SidechatAsset</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#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#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 {SidechatAsset[]} assets - array of 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} SidechatAsset
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
+ * A user's identity information
63
+ * @typedef {Object} SidechatIdentity
64
+ * @prop {String} name - representation of user's name (varies across app)
65
+ * @prop {Boolean} posted_with_username - undocumented
66
+ */
67
+
68
+ /**
69
+ * An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header
70
+ * @typedef {String} SidechatPrivateAssetURL
71
+ */
72
+
73
+ /**
74
+ * A cursor for paginating through post lists
75
+ * @typedef {String} SidechatCursorString
76
+ */
77
+
78
+ /**
79
+ * A vote on a comment or post
80
+ * @typedef {"upvote"|"downvote"|"none"} SidechatVoteString
81
+ */
82
+
83
+ /**
84
+ * A user's bearer authentication token needed for most requests
85
+ * @typedef {String} SidechatAuthToken
86
+ */
87
+
88
+ /**
89
+ * A list of posts and the associated cursor
90
+ * @typedef {Object} SidechatPostsAndCursor
91
+ * @prop {SidechatPostOrComment[]} posts
92
+ * @prop {SidechatCursorString} cursor
93
+ */
94
+
95
+ /**
96
+ * @tutorial Hello world
97
+ */
98
+ </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#SidechatAsset">SidechatAsset</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#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#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/docs/tutorials/Authentication.md ADDED
@@ -0,0 +1,46 @@
1
+ There are two supported methods of authenticating a Sidechat.js API client. We recommend the automatic method, but you may choose to use the manual method if your project involves multiple instances of `SidechatAPIClient`.
2
+
3
+ Go ahead and import `SidechatAPIClient` from the module:
4
+
5
+ ```javascript
6
+ import { SidechatAPIClient } from "sidechat.js";
7
+ ```
8
+
9
+ ### Automatic method
10
+
11
+ For existing users, this is trivial. First, send the user a verification code to their phone number. Make sure the passed phone number is in a 10-digit format with no dashes, spaces, or parentheses:
12
+
13
+ ```javascript
14
+ const phoneNumber = /* User's phone number */;
15
+ await API.loginViaSMS(phoneNumber);
16
+ ```
17
+
18
+ Then once the user has inputted the 6-digit code into your application, verify it with the API:
19
+
20
+ ```javascript
21
+ const code = /* SMS verification code */;
22
+ await API.verifySMSCode(phoneNumber, code);
23
+ ```
24
+
25
+ If the user already exists, calling those two functions will set the user token and all requests from here on out using this instance of the API client will be automatically authenticated.
26
+
27
+ If the user has not used Sidechat before, the `verifySMSCode` will return a `registrationID`, which you should store and then use to call the `setAge` function:
28
+
29
+ ```javascript
30
+ // Here "res" refers to the result of verifySMSCode()
31
+ const { registration_id } = res;
32
+ await API.setAge(18, registration_id);
33
+ ```
34
+
35
+ Now the user should be logged in properly and future requests will be automatically authenticated. You may still need to [add an email address](tutorial-Email%20Registration.html) for most functionality.
36
+
37
+ ### Manual method
38
+
39
+ You can pass a user token directly to the constructor initialization:
40
+
41
+ ```javascript
42
+ const token = /* User bearer token as a string */;
43
+ const API = new SidechatAPIClient(token);
44
+ ```
45
+
46
+ All requests from here on out using this instance of the API client will automatically use the token passed to the constructor.
package/docs/tutorials/Email Registration.md ADDED
@@ -0,0 +1,16 @@
1
+ > You can only start this process once you have [authenticated as a user](tutorial-Authentication.html).
2
+
3
+ Start by sending a verification email to the user:
4
+
5
+ ```javascript
6
+ const email = /* User's email address */;
7
+ await API.registerEmail(email);
8
+ ```
9
+
10
+ Once the user has clicked the link in the verification email, verify that they've clicked it:
11
+
12
+ ```javascript
13
+ await API.checkEmailVerification();
14
+ ```
15
+
16
+ You should be verified!
package/jsdoc.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "source": {
3
3
  "include": [
4
- "index.js",
4
+ "src/index.js",
5
5
  "package.json",
6
6
  "README.md",
7
- "types/SidechatTypes.js",
8
- "classes/SidechatAPIError.js"
7
+ "src/types/SidechatTypes.js",
8
+ "src/classes/SidechatAPIClient.js",
9
+ "src/classes/SidechatAPIError.js"
9
10
  ],
10
11
  "includePattern": ".js$",
11
12
  "excludePattern": "(node_modules/|docs)"
@@ -15,6 +16,7 @@
15
16
  "encoding": "utf8",
16
17
  "readme": "./README.md",
17
18
  "destination": "docs/",
19
+ "tutorials": "docs/tutorials",
18
20
  "package": "./package.json",
19
21
  "recurse": true,
20
22
  "verbose": true,
@@ -22,13 +24,15 @@
22
24
  "theme_opts": {
23
25
  "default_theme": "dark",
24
26
  "homepageTitle": "Sidechat.js Documentation",
27
+ "base_url": "https://micahlindley.com/sidechat.js/",
25
28
  "menu": [
26
29
  {
27
30
  "title": "Offsides (Sidechat for Android)",
28
31
  "link": "https://github.com/micahlt/offsides#README.md",
29
32
  "target": "_blank"
30
33
  }
31
- ]
34
+ ],
35
+ "sections": ["Tutorials", "Classes", "Global"]
32
36
  }
33
37
  },
34
38
  "markdown": {
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "sidechat.js",
3
- "version": "1.0.0",
3
+ "version": "2.0.0",
4
4
  "description": "A reverse-engineered API wrapper for Sidechat",
5
5
  "type": "module",
6
- "source": "index.js",
6
+ "source": "./src/index.js",
7
7
  "exports": {
8
8
  "require": "./dist/sidechat.cjs",
9
9
  "default": "./dist/sidechat.modern.js"
@@ -14,7 +14,7 @@
14
14
  "scripts": {
15
15
  "build": "microbundle",
16
16
  "dev": "microbundle watch",
17
- "docs": "npx jsdoc --configure jsdoc.json"
17
+ "docs": "npx jsdoc --configure jsdoc.json --verbose"
18
18
  },
19
19
  "repository": {
20
20
  "type": "git",
@@ -31,6 +31,7 @@
31
31
  },
32
32
  "devDependencies": {
33
33
  "clean-jsdoc-theme": "^4.2.17",
34
- "microbundle": "^0.15.1"
34
+ "microbundle": "^0.15.1",
35
+ "prompt-sync": "^4.2.0"
35
36
  }
36
37
  }